docs: rename copilot-instructions.md to agents.md #1915
+102
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Follows agents.md convention (https://agents.md) for broader AI agent support - Add MCP Inspector CLI instructions for testing stdio server - Pin inspector version to 0.7.0 for reproducibility
Contributor
There was a problem hiding this comment.
Pull request overview
Renames/retitles the repository’s AI instruction document to follow the agents.md convention and adds reproducible MCP Inspector CLI examples for exercising the stdio server.
Changes:
- Updated the instruction doc title/content to “Agent Instructions” and noted the
agents.mdconvention. - Added MCP Inspector CLI usage examples (pinned to
@modelcontextprotocol/inspector@0.7.0) for listing/calling tools.
Comments suppressed due to low confidence (1)
.github/agents.md:76
- The MCP Inspector examples embed the GitHub Personal Access Token inside the
--configJSON passed on the command line. That encourages putting secrets into shell history and can expose them via process listing. Prefer having users setGITHUB_PERSONAL_ACCESS_TOKENin their environment (or use a local config file) and have the inspector/server inherit it, and update the note accordingly.
- Move AGENTS.md to repository root per agents.md spec - Add copilot-setup-steps.yml workflow for Copilot coding agent - Pre-installs: Go deps, goimports, MCP Inspector, builds server binary
Agents must disclose AI assistance in PR/issue bodies, following the pattern used by modelcontextprotocol/modelcontextprotocol.
|
|
||
| jobs: | ||
| copilot-setup-steps: | ||
| runs-on: ubuntu-latest |
Contributor
There was a problem hiding this comment.
is it something just for ubuntu?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Renames
.github/copilot-instructions.mdtoAGENTS.md(at repo root) following the agents.md convention for broader AI agent support.Changes
AGENTS.mdat repository root per agents.md speccopilot-setup-steps.ymlworkflow for Copilot coding agent environmentCONTRIBUTING.mdwith AI Contributions sectionCopilot Setup Steps
✅ Workflow passing: https://github.com/github/github-mcp-server/actions/runs/21444663923
Pre-installs:
Testing
The MCP Inspector examples allow developers to quickly test tool functionality:
npx @modelcontextprotocol/inspector@0.7.0 --cli \ --config '{"mcpServers":{"github":{"command":"./github-mcp-server","args":["stdio"],"env":{"GITHUB_PERSONAL_ACCESS_TOKEN":"your-token"}}}}' \ --server github \ --method tools/list