Skip to content

Commit cfda4e2

Browse files
add AdaL CLI installation instructions
1 parent 2b55513 commit cfda4e2

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
8181

8282
### Install in other MCP hosts
8383

84+
- **[AdaL CLI](/docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI
8485
- **[Copilot CLI](/docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI
8586
- **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
8687
- **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
@@ -351,6 +352,7 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
351352

352353
For other MCP host applications, please refer to our installation guides:
353354

355+
- **[AdaL CLI](docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI
354356
- **[Copilot CLI](docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI
355357
- **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
356358
- **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop

docs/installation-guides/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This directory contains detailed installation instructions for the GitHub MCP Server across different host applications and IDEs. Choose the guide that matches your development environment.
44

55
## Installation Guides by Host Application
6+
- **[AdaL CLI](install-adal-cli.md)** - Installation guide for AdaL CLI
67
- **[Copilot CLI](install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI
78
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
89
- **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
@@ -16,6 +17,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
1617

1718
| Host Application | Local GitHub MCP Support | Remote GitHub MCP Support | Prerequisites | Difficulty |
1819
|-----------------|---------------|----------------|---------------|------------|
20+
| AdaL CLI || ✅ PAT + ❌ No OAuth | Docker, GitHub PAT | Easy |
1921
| Copilot CLI || ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
2022
| Copilot in VS Code || ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: VS Code 1.101+ | Easy |
2123
| Copilot Coding Agent || ✅ Full (on by default; no auth needed) | Any _paid_ copilot license | Default on |
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Install GitHub MCP Server in AdaL CLI
2+
3+
## Prerequisites
4+
5+
1. AdaL CLI installed — `npm install -g @sylphai/adal-cli` (requires Node.js 20+)
6+
2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes
7+
8+
## Option 1 — Shortcut (Easiest)
9+
10+
AdaL CLI has a pre-configured shortcut for GitHub. Set your token before starting AdaL, then add the server:
11+
12+
```bash
13+
# macOS / Linux
14+
export GITHUB_TOKEN="ghp_xxxx"
15+
16+
# Windows (PowerShell)
17+
$env:GITHUB_TOKEN="ghp_xxxx"
18+
```
19+
20+
Then inside your AdaL session:
21+
22+
```bash
23+
/mcp add github
24+
```
25+
26+
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.
27+
28+
## Option 2 — Remote GitHub MCP Server
29+
30+
Connect directly to GitHub's hosted MCP server at `https://api.githubcopilot.com/mcp/` using a PAT header.
31+
32+
<details>
33+
<summary>AdaL CLI Remote Server Connection</summary>
34+
35+
```bash
36+
/mcp add github --transport http --url https://api.githubcopilot.com/mcp/ --header "Authorization:Bearer YOUR_GITHUB_PAT"
37+
```
38+
39+
Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens).
40+
41+
</details>
42+
43+
## Option 3 — Local GitHub MCP Server (Docker)
44+
45+
Run the server locally using Docker.
46+
47+
### Prerequisites
48+
49+
- [Docker](https://www.docker.com/) installed and running
50+
- [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes
51+
52+
<details>
53+
<summary>AdaL CLI Local Server Connection</summary>
54+
55+
```bash
56+
/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"
57+
```
58+
59+
Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens).
60+
61+
</details>
62+
63+
## Verify the Connection
64+
65+
After adding the server, test it inside AdaL:
66+
67+
```
68+
/mcp
69+
```
70+
71+
Select the `github` server → **Test Connection**. You should see the available GitHub tools listed.
72+
73+
## Troubleshooting
74+
75+
- **"Connection failed"** — Verify your PAT is valid and has the required scopes (`repo`, etc.)
76+
- **Token not read (shortcut)** — Make sure `GITHUB_TOKEN` is set *before* starting AdaL; restart required if set after launch
77+
- **Docker errors** — Ensure Docker is running: `docker ps`
78+
- **Token not found (local)** — Confirm your PAT is correctly set in the `--env` flag
79+
80+
For more details, see the main [README.md](../../README.md).

0 commit comments

Comments
 (0)