beads/website/docs/integrations/github-copilot.md
Scott Nixon 18f47fe8b6
docs: add GitHub Copilot integration guide with cross-platform MCP paths (#1348)
* fix(export): populate export_hashes after successful export (GH#1278)

Child issues created with --parent were missing from export_hashes table,
which affects integrity tracking and future incremental export features.

This fix ensures SetExportHash() is called for all exported issues:
- Updated ExportResult to include IssueContentHashes map
- Updated finalizeExport() to call SetExportHash() for each exported issue
- Updated exportToJSONLDeferred() to collect content hashes during export
- Updated performIncrementalExport() to collect content hashes for dirty issues
- Updated exportToJSONLWithStore() to call SetExportHash() after export
- Updated daemon's handleExport() to call SetExportHash() after export

Added test TestExportPopulatesExportHashes to verify the fix works for
both regular and hierarchical (child) issue IDs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: add GitHub Copilot integration guide

Add comprehensive documentation for using beads with GitHub Copilot in VS Code via the MCP server.

New files:
- docs/COPILOT_INTEGRATION.md - Complete setup guide with prerequisites, MCP tools reference, example workflows, troubleshooting, and FAQ
- website/docs/integrations/github-copilot.md - Shorter website version

Updated files:
- docs/INSTALLING.md - Added GitHub Copilot row to setup matrix and new "GitHub Copilot (VS Code)" section with quick setup steps
- website/docs/getting-started/ide-setup.md - Added GitHub Copilot section
- website/docs/integrations/mcp-server.md - Added VS Code / GitHub Copilot configuration examples for both .vscode/mcp.json and settings.json

Key clarifications:
- Beads is a system-wide CLI tool installed once, not cloned into projects
- The .beads/ directory only contains the issue database
- Added FAQ addressing "Do I need to clone beads?" explicitly

Fixes #148

* docs: add cross-platform paths for user-level VS Code MCP config

  Add Linux and Windows paths alongside macOS for the VS Code
  user-level MCP configuration. Users can now find the correct
  path for their platform in a simple table format.

  Paths by platform:
  - macOS: ~/Library/Application Support/Code/User/mcp.json
  - Linux: ~/.config/Code/User/mcp.json
  - Windows: %APPDATA%\Code\User\mcp.json

  Fixes #148

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-27 11:25:14 -08:00

2.9 KiB

id title sidebar_position
github-copilot GitHub Copilot 4

GitHub Copilot Integration

How to use beads with GitHub Copilot in VS Code.

Setup

Quick Setup

  1. Install beads-mcp:

    uv tool install beads-mcp
    
  2. 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": []
        }
      }
    }
    
  3. Initialize beads:

    bd init --quiet
    
  4. Reload VS Code

Verify Setup

Ask Copilot Chat: "What beads issues are ready to work on?"

Using Natural Language

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

MCP Tools

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_sync Sync to git
beads_dep_add Add dependency
beads_dep_tree Show dependency tree

Copilot Instructions

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 sync` - Sync with git

Troubleshooting

Tools not appearing

  1. Check VS Code 1.96+
  2. Verify mcp.json syntax is valid JSON
  3. Reload VS Code window
  4. Check Output panel for MCP errors

"beads-mcp not found"

# Check installation
which beads-mcp

# Reinstall if needed
uv tool install beads-mcp --force

No database found

bd init --quiet

FAQ

Do I need to clone beads?

No. Beads is a system-wide CLI tool. Install once, use everywhere. The .beads/ directory in your project only contains the issue database.

What about git hooks?

Git hooks are optional. They auto-sync issues but you can skip them during bd init and manually run bd sync instead.

See Also