docs: add AdaL CLI installation instructions to README#1992
docs: add AdaL CLI installation instructions to README#1992Abdulrahmansoliman wants to merge 3 commits intoupstash:masterfrom
Conversation
Co-Authored-By: AdaL <adal@sylph.ai>
There was a problem hiding this comment.
Pull request overview
This PR adds installation instructions for AdaL CLI to the Context7 MCP README, aiming to make the tool accessible to the AdaL developer community. The changes include a new installation section with both remote (HTTP) and local (NPX) connection commands, along with an update to the ctx7 setup documentation to mention AdaL as a supported agent.
Changes:
- Added new "Install in AdaL CLI" section with remote and local server connection examples
- Updated
ctx7 setupdescription to include--adalas a targeting option
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| #### AdaL CLI Remote Server Connection | ||
|
|
||
| ```bash | ||
| /mcp add context7 --transport http --url https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY:YOUR_API_KEY" |
There was a problem hiding this comment.
The header format "CONTEXT7_API_KEY:YOUR_API_KEY" uses a colon without a space, which is inconsistent with other sections. In the Claude Code section (line 99), it uses "CONTEXT7_API_KEY: YOUR_API_KEY" with a space after the colon. Please use consistent header formatting across all sections.
| /mcp add context7 --transport http --url https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY:YOUR_API_KEY" | |
| /mcp add context7 --transport http --url https://mcp.context7.com/mcp --header "CONTEXT7_API_KEY: YOUR_API_KEY" |
README.md
Outdated
| ``` | ||
|
|
||
| Authenticates via OAuth, generates an API key, and configures the MCP server and rule for your agents. Use `--cursor`, `--claude`, or `--opencode` to target a specific agent. | ||
| Authenticates via OAuth, generates an API key, and configures the MCP server and rule for your agents. Use `--cursor`, `--claude`, `--opencode`, or `--adal` to target a specific agent. |
There was a problem hiding this comment.
The documentation claims that --adal is a valid targeting option for ctx7 setup, but this flag is not implemented in the CLI code. The SetupAgent type in packages/cli/src/setup/agents.ts:5 only includes "claude", "cursor", and "opencode". The setup command in packages/cli/src/commands/setup.ts does not have an --adal option. Either remove the --adal reference from this line or implement the functionality in the CLI first.
| Authenticates via OAuth, generates an API key, and configures the MCP server and rule for your agents. Use `--cursor`, `--claude`, `--opencode`, or `--adal` to target a specific agent. | |
| Authenticates via OAuth, generates an API key, and configures the MCP server and rule for your agents. Use `--cursor`, `--claude`, or `--opencode` to target a specific agent. |
README.md
Outdated
| <details> | ||
| <summary><b>Install in AdaL CLI</b></summary> | ||
|
|
||
| Run these commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL) for more info. |
There was a problem hiding this comment.
The documentation link points to the general AdaL GitHub repository (https://github.com/SylphAI-Inc/AdaL) rather than specific MCP documentation. This is inconsistent with other sections which link to specific MCP documentation pages. For example, Claude Code links to https://code.claude.com/docs/en/mcp and Opencode links to https://opencode.ai/docs/mcp-servers. Please verify that AdaL has MCP-specific documentation and update the link accordingly, or use a more specific anchor within the repository.
| Run these commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL) for more info. | |
| Run these commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL?tab=readme-ov-file#mcp-servers) for more info. |
README.md
Outdated
| <details> | ||
| <summary><b>Install in AdaL CLI</b></summary> | ||
|
|
||
| Run these commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL) for more info. |
There was a problem hiding this comment.
The introductory text says "Run these commands" (plural), but the pattern should match other sections. Claude Code (line 88) says "Run this command" (singular) even though it has multiple examples for local and remote. Consider using "Run one of these commands" or following the existing pattern of other sections for consistency.
| Run these commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL) for more info. | |
| Run one of the following commands directly within your AdaL session. See [AdaL CLI MCP docs](https://github.com/SylphAI-Inc/AdaL) for more info. |
Co-Authored-By: AdaL <adal@sylph.ai>
Summary
Context7 is an incredibly powerful tool for terminal-based agents, so it makes perfect sense to make it easily accessible to the AdaL developer community.
This PR updates the
README.mdto include installation instructions for AdaL CLI (a unified terminal agent), placing it right alongside the setup guides for Claude Code and Opencode.Changes Made
Install in AdaL CLIsection to the README./mcp addsyntax.ctx7 setupsection to include--adalas a targeting option.Testing
🌸 Generated with AdaL