Skip to content

Commit 0877f6c

Browse files
docs: rename copilot-instructions.md to agents.md
- 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
1 parent 1820a0f commit 0877f6c

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed
Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# GitHub MCP Server - Copilot Instructions
1+
# GitHub MCP Server - Agent Instructions
2+
3+
> This file follows the [agents.md](https://agents.md) convention for AI agent instructions.
24
35
## Project Overview
46

@@ -59,6 +61,29 @@ go test ./pkg/github -v
5961
go test ./pkg/github -run TestGetMe
6062
```
6163

64+
### Testing with MCP Inspector
65+
66+
Use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) CLI to test the server:
67+
68+
```bash
69+
# Build the server first
70+
go build -v ./cmd/github-mcp-server
71+
72+
# List available tools
73+
npx @modelcontextprotocol/inspector@0.7.0 --cli \
74+
--config '{"mcpServers":{"github":{"command":"./github-mcp-server","args":["stdio"],"env":{"GITHUB_PERSONAL_ACCESS_TOKEN":"your-token"}}}}' \
75+
--server github \
76+
--method tools/list
77+
78+
# Call a specific tool (e.g., get authenticated user)
79+
npx @modelcontextprotocol/inspector@0.7.0 --cli \
80+
--config '{"mcpServers":{"github":{"command":"./github-mcp-server","args":["stdio"],"env":{"GITHUB_PERSONAL_ACCESS_TOKEN":"your-token"}}}}' \
81+
--server github \
82+
--method tools/call --tool-name get_me
83+
```
84+
85+
Note: Replace `your-token` with a valid GitHub Personal Access Token.
86+
6287
## Project Structure
6388

6489
### Directory Layout

0 commit comments

Comments
 (0)