diff --git a/README.md b/README.md index 7c7b84a9..8cf6a880 100644 --- a/README.md +++ b/README.md @@ -400,6 +400,39 @@ npm install -g @colbymchenry/codegraph +
+GitHub Copilot CLI (manual setup) + +The interactive installer doesn't auto-configure [GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) yet, so wire it up by hand — it takes about a minute. + +**1. Install the `codegraph` CLI** (if you haven't already) — see [Get Started](#get-started). + +**2. Add the MCP server to `~/.copilot/mcp-config.json`:** +```json +{ + "mcpServers": { + "codegraph": { + "type": "stdio", + "command": "codegraph", + "args": ["serve", "--mcp"], + "tools": ["*"] + } + } +} +``` + +Unlike Claude Code, Copilot CLI **requires the `tools` key** — without it, none of CodeGraph's tools are enabled. `["*"]` enables them all; to allowlist explicitly instead, list the tool names (`codegraph_search`, `codegraph_explore`, `codegraph_callers`, `codegraph_callees`, `codegraph_impact`, `codegraph_node`, `codegraph_status`, `codegraph_files`). The config file lives in `~/.copilot` by default — set `COPILOT_HOME` to relocate it. You can also add the server interactively with the `/mcp add` slash command instead of editing the file. + +**3. Reload MCP servers** — run `/mcp` in an interactive session (or `/restart`) so Copilot CLI launches `codegraph serve --mcp`. Confirm it connected with `/mcp` or `/env`. + +**4. Initialize the project** so the server has an index to answer against: +```bash +cd your-project +codegraph init -i +``` + +
+
Agent Tool Guidance @@ -612,6 +645,8 @@ is written): - **Antigravity IDE** - **Kiro** +> **GitHub Copilot CLI** is also supported via a quick manual config — see [GitHub Copilot CLI (manual setup)](#quick-start) under Quick Start. + ## Supported Languages | Language | Extension | Status |