From cfda4e2be086ac5f98c8f5750f61914f321239e2 Mon Sep 17 00:00:00 2001 From: AbdelrahmanSoliman Date: Tue, 24 Feb 2026 12:01:43 -0800 Subject: [PATCH 1/2] add AdaL CLI installation instructions --- README.md | 2 + docs/installation-guides/README.md | 2 + docs/installation-guides/install-adal-cli.md | 80 ++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 docs/installation-guides/install-adal-cli.md diff --git a/README.md b/README.md index c02261970..774df0e2a 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block ### Install in other MCP hosts +- **[AdaL CLI](/docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](/docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[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 For other MCP host applications, please refer to our installation guides: +- **[AdaL CLI](docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop diff --git a/docs/installation-guides/README.md b/docs/installation-guides/README.md index 4a300e3f4..a698cdda2 100644 --- a/docs/installation-guides/README.md +++ b/docs/installation-guides/README.md @@ -3,6 +3,7 @@ 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. ## Installation Guides by Host Application +- **[AdaL CLI](install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE @@ -16,6 +17,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se | Host Application | Local GitHub MCP Support | Remote GitHub MCP Support | Prerequisites | Difficulty | |-----------------|---------------|----------------|---------------|------------| +| AdaL CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker, GitHub PAT | Easy | | Copilot CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy | | Copilot in VS Code | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT
Remote: VS Code 1.101+ | Easy | | Copilot Coding Agent | ✅ | ✅ Full (on by default; no auth needed) | Any _paid_ copilot license | Default on | diff --git a/docs/installation-guides/install-adal-cli.md b/docs/installation-guides/install-adal-cli.md new file mode 100644 index 000000000..b61c80a21 --- /dev/null +++ b/docs/installation-guides/install-adal-cli.md @@ -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. + +
+AdaL CLI Remote Server Connection + +```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). + +
+ +## 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 + +
+AdaL CLI Local Server Connection + +```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). + +
+ +## 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). From 9cc9adc736642cefb823f85ba592d54365477fd4 Mon Sep 17 00:00:00 2001 From: AbdelrahmanSoliman Date: Tue, 24 Feb 2026 14:55:12 -0800 Subject: [PATCH 2/2] add adal documnetation --- README.md | 4 ++-- docs/installation-guides/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 774df0e2a..f7cdb889a 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,6 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block ### Install in other MCP hosts -- **[AdaL CLI](/docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](/docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI @@ -89,6 +88,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block - **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE - **[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE - **[Rovo Dev CLI](/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI +- **[AdaL CLI](/docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI > **Note:** Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info. @@ -352,13 +352,13 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c For other MCP host applications, please refer to our installation guides: -- **[AdaL CLI](docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop - **[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE - **[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI - **[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE +- **[AdaL CLI](docs/installation-guides/install-adal-cli.md)** - Installation guide for AdaL CLI For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**. diff --git a/docs/installation-guides/README.md b/docs/installation-guides/README.md index a698cdda2..12afc153f 100644 --- a/docs/installation-guides/README.md +++ b/docs/installation-guides/README.md @@ -3,7 +3,6 @@ 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. ## Installation Guides by Host Application -- **[AdaL CLI](install-adal-cli.md)** - Installation guide for AdaL CLI - **[Copilot CLI](install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI - **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot - **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE @@ -12,12 +11,12 @@ This directory contains detailed installation instructions for the GitHub MCP Se - **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI - **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex - **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE +- **[AdaL CLI](install-adal-cli.md)** - Installation guide for AdaL CLI ## Support by Host Application | Host Application | Local GitHub MCP Support | Remote GitHub MCP Support | Prerequisites | Difficulty | |-----------------|---------------|----------------|---------------|------------| -| AdaL CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker, GitHub PAT | Easy | | Copilot CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy | | Copilot in VS Code | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT
Remote: VS Code 1.101+ | Easy | | Copilot Coding Agent | ✅ | ✅ Full (on by default; no auth needed) | Any _paid_ copilot license | Default on | @@ -30,6 +29,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se | Windsurf | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy | | Copilot in Xcode | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT
Remote: Copilot for Xcode 0.41.0+ | Easy | | Copilot in Eclipse | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT
Remote: Eclipse Plug-in for Copilot 0.10.0+ | Easy | +| AdaL CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker, GitHub PAT | Easy | **Legend:** - ✅ = Fully supported