-
Notifications
You must be signed in to change notification settings - Fork 3.6k
docs: add AdaL CLI installation guide #2083
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Abdulrahmansoliman
wants to merge
2
commits into
github:main
Choose a base branch
from
Abdulrahmansoliman:docs/add-adal-cli
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+84
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # Install GitHub MCP Server in AdaL CLI | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. AdaL CLI installed — `npm install -g @sylphai/adal-cli` (requires Node.js 20+) | ||
| 2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes | ||
|
|
||
| ## Option 1 — Shortcut (Easiest) | ||
|
|
||
| AdaL CLI has a pre-configured shortcut for GitHub. Set your token before starting AdaL, then add the server: | ||
|
|
||
| ```bash | ||
| # macOS / Linux | ||
| export GITHUB_TOKEN="ghp_xxxx" | ||
|
|
||
| # Windows (PowerShell) | ||
| $env:GITHUB_TOKEN="ghp_xxxx" | ||
| ``` | ||
|
|
||
| Then inside your AdaL session: | ||
|
|
||
| ```bash | ||
| /mcp add github | ||
| ``` | ||
|
|
||
| AdaL reads the `GITHUB_TOKEN` environment variable at startup. See [AdaL CLI MCP docs](https://docs.sylph.ai/features/mcp-support-proposed) for more info. | ||
|
|
||
| ## Option 2 — Remote GitHub MCP Server | ||
|
|
||
| Connect directly to GitHub's hosted MCP server at `https://api.githubcopilot.com/mcp/` using a PAT header. | ||
|
|
||
| <details> | ||
| <summary>AdaL CLI Remote Server Connection</summary> | ||
|
|
||
| ```bash | ||
| /mcp add github --transport http --url https://api.githubcopilot.com/mcp/ --header "Authorization:Bearer YOUR_GITHUB_PAT" | ||
| ``` | ||
|
|
||
| Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens). | ||
|
|
||
| </details> | ||
|
|
||
| ## Option 3 — Local GitHub MCP Server (Docker) | ||
|
|
||
| Run the server locally using Docker. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Docker](https://www.docker.com/) installed and running | ||
| - [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes | ||
|
|
||
| <details> | ||
| <summary>AdaL CLI Local Server Connection</summary> | ||
|
|
||
| ```bash | ||
| /mcp add github --command docker --args "run,-i,--rm,-e,GITHUB_PERSONAL_ACCESS_TOKEN,ghcr.io/github/github-mcp-server" --env "GITHUB_PERSONAL_ACCESS_TOKEN=YOUR_GITHUB_PAT" | ||
| ``` | ||
|
|
||
| Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens). | ||
|
||
|
|
||
| </details> | ||
|
|
||
| ## Verify the Connection | ||
|
|
||
| After adding the server, test it inside AdaL: | ||
|
|
||
| ``` | ||
| /mcp | ||
| ``` | ||
|
|
||
| Select the `github` server → **Test Connection**. You should see the available GitHub tools listed. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - **"Connection failed"** — Verify your PAT is valid and has the required scopes (`repo`, etc.) | ||
| - **Token not read (shortcut)** — Make sure `GITHUB_TOKEN` is set *before* starting AdaL; restart required if set after launch | ||
| - **Docker errors** — Ensure Docker is running: `docker ps` | ||
| - **Token not found (local)** — Confirm your PAT is correctly set in the `--env` flag | ||
|
|
||
| For more details, see the main [README.md](../../README.md). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The GitHub Personal Access Token link uses an inconsistent URL. This line links to
https://github.com/settings/tokens, but it should usehttps://github.com/settings/personal-access-tokens/newto match the convention used throughout the codebase and in this document's Prerequisites section (lines 6 and 50).