website/versioned_docs/version-1.0.0/integrations/github-copilot.md
How to use beads with GitHub Copilot in VS Code.
Install beads-mcp:
uv tool install beads-mcp
Create .vscode/mcp.json in your project:
{
"servers": {
"beads": {
"command": "beads-mcp"
}
}
}
For all projects: Add to VS Code user-level MCP config:
| Platform | Path |
|---|---|
| macOS | ~/Library/Application Support/Code/User/mcp.json |
| Linux | ~/.config/Code/User/mcp.json |
| Windows | %APPDATA%\Code\User\mcp.json |
{
"servers": {
"beads": {
"command": "beads-mcp",
"args": []
}
}
}
Initialize beads:
bd init --quiet
Reload VS Code
Ask Copilot Chat: "What beads issues are ready to work on?"
With MCP configured, interact naturally:
You: Create a bug for the login timeout
Copilot: Created bd-42: Login timeout bug
You: What issues are ready?
Copilot: 3 issues ready: bd-42, bd-99, bd-17
You: Close bd-42, it's fixed
Copilot: Closed bd-42
| Tool | Description |
|---|---|
beads_ready | List unblocked issues |
beads_create | Create new issue |
beads_show | Show issue details |
beads_update | Update issue |
beads_close | Close issue |
beads_dolt_push | Push to Dolt remote |
beads_dep_add | Add dependency |
beads_dep_tree | Show dependency tree |
Optionally add .github/copilot-instructions.md:
## Issue Tracking
This project uses **bd (beads)** for issue tracking.
Run `bd prime` for workflow context.
Quick reference:
- `bd ready` - Find unblocked work
- `bd create "Title" --type task --priority 2` - Create issue
- `bd close <id>` - Complete work
- `bd dolt push` - Push changes to Dolt remote
# Check installation
which beads-mcp
# Reinstall if needed
uv tool install beads-mcp --force
bd init --quiet
No. Beads is a system-wide CLI tool. Install once, use everywhere. The .beads/ directory in your project only contains the issue database.
Git hooks are optional. They auto-sync issues but you can skip them during bd init and manually run bd dolt push / bd dolt pull instead.