Skip to content

📚 Documentation needed for commit 593425b (MCP Configuration) #5

@raykao

Description

@raykao

Documentation Required for Commit 593425b

Summary

Commit 593425b introduces MCP (Model Context Protocol) configuration for GitHub Copilot integration and updates workflow authentication patterns.

What Changed

  1. New File: .github/mcp.json - MCP server configuration for GitHub API access
  2. Workflow Update: .github/workflows/copilot.generate-docs.yml now uses:
    • GH_TOKEN for Copilot CLI authentication
    • GITHUB_MCP_TOKEN for MCP GitHub operations
    • --mcp-config flag (replaces deprecated --enable-all-github-mcp-tools)

Documentation Needed

1. Update docs/github-deployment.md

  • Add section explaining MCP configuration requirements
  • Document the dual-token authentication pattern:
    • COPILOT_CLI_TOKEN: Personal PAT for Copilot API
    • GITHUB_TOKEN: Workflow token for MCP operations (issues, PRs, etc.)
  • Explain token scopes needed for each

2. Create/Update Workflow Documentation

  • Document the .github/mcp.json configuration format
  • Explain how MCP enables Copilot to interact with GitHub (create issues, assign tasks)
  • Provide troubleshooting guidance for MCP authentication failures

3. Update docs/development.md or Create New MCP Guide

  • Explain what MCP is and why it's used
  • Document local development setup with MCP
  • Provide examples of MCP-enabled Copilot capabilities

Breaking Changes

⚠️ Workflow now requires two secrets:

  • COPILOT_CLI_TOKEN (existing)
  • Workflow must have access to GITHUB_TOKEN with issue write permissions

Related Files

  • .github/mcp.json
  • .github/workflows/copilot.generate-docs.yml
  • docs/github-deployment.md
  • docs/development.md

This issue was automatically created by analyzing commit 593425b

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions