doc: add README with project introduction and glossary

[feloy]

Created README.md for kortex-cli with:

• Project title and introduction explaining the CLI's purpose
• List of supported agents (Claude Code, Goose, Cursor)
• Key features including skills, MCP servers, and LLM integrations
• Glossary defining important terms (Agent, LLM, MCP, Skills)

(100% generated using Claude Code inside container)

[coderabbitai]

Warning

Rate limit exceeded

@feloy has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b4aa14d and 70e6d5f.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

Added README.md documentation for the kortex-cli project, including an introduction, list of supported agents (Claude Code, Goose, Cursor), key features overview (custom skills, MCP connections, LLM integration), and a glossary of terms.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added initial project documentation covering introduction, supported agents, key features, and terminology glossary for kortex-cli.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'doc: add README with project introduction and glossary' clearly and specifically describes the main change—adding a README file with documentation content.
Description check	✅ Passed	The description is directly related to the changeset, providing details about the README content including agents, features, and glossary definitions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (2)

README.md (2)

7-12: Add source links for each supported agent.

At Line 9, Line 10, and Line 11, consider linking each agent name to its official documentation/repository to reduce ambiguity and prevent stale naming over time.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 7 - 12, Update the "Supported Agents" list to link
each agent name to its authoritative documentation or repository: replace the
plain text "Claude Code", "Goose", and "Cursor" entries with markdown links
pointing to their official URLs (e.g., Anthropic/Claude docs or CLI repo for
Claude Code, the Goose project repo/docs, and the Cursor official site/repo).
Ensure the link text remains the agent name (e.g., [Claude Code](URL)) and
choose stable canonical URLs (official docs, GitHub repos, or company pages) to
avoid stale references.

---

13-19: Add one concrete usage example for the listed features.

The feature list is useful, but adding a minimal CLI example (e.g., one command showing agent + skills + MCP config) would make onboarding much faster.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 13 - 19, Add a concrete minimal usage example to the
README showing how to configure an agent with custom skills, connect to an MCP
server, and specify an LLM provider via a single CLI command; include the
command invocation, brief description of flags (agent name, --skills, --mcp-url,
--llm-provider) and a one-line expected outcome so readers can copy-paste to try
"agent + skills + MCP config" quickly.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 7-12: Update the "Supported Agents" list to link each agent name
to its authoritative documentation or repository: replace the plain text "Claude
Code", "Goose", and "Cursor" entries with markdown links pointing to their
official URLs (e.g., Anthropic/Claude docs or CLI repo for Claude Code, the
Goose project repo/docs, and the Cursor official site/repo). Ensure the link
text remains the agent name (e.g., [Claude Code](URL)) and choose stable
canonical URLs (official docs, GitHub repos, or company pages) to avoid stale
references.
- Around line 13-19: Add a concrete minimal usage example to the README showing
how to configure an agent with custom skills, connect to an MCP server, and
specify an LLM provider via a single CLI command; include the command
invocation, brief description of flags (agent name, --skills, --mcp-url,
--llm-provider) and a one-line expected outcome so readers can copy-paste to try
"agent + skills + MCP config" quickly.

---

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3b4662 and b4aa14d.

📒 Files selected for processing (1)

• README.md

[benoitf]

hello, I'm not sure about goose agent ?

AFAIK Claude, gemini and cursor CLI yes

[jeffmaury]

LGTM

[feloy]

hello, I'm not sure about goose agent ?

AFAIK Claude, gemini and cursor CLI yes

@slemeur wdyt?

[benoitf]

will require a rebase (some checks are pending)