Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion .github/copilot-instructions.md → .github/agents.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# GitHub MCP Server - Copilot Instructions
# GitHub MCP Server - Agent Instructions

> This file follows the [agents.md](https://agents.md) convention for AI agent instructions.

## Project Overview

Expand Down Expand Up @@ -59,6 +61,29 @@ go test ./pkg/github -v
go test ./pkg/github -run TestGetMe
```

### Testing with MCP Inspector

Use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) CLI to test the server:

```bash
# Build the server first
go build -v ./cmd/github-mcp-server

# List available tools
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

# Call a specific tool (e.g., get authenticated user)
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/call --tool-name get_me
```

Note: Replace `your-token` with a valid GitHub Personal Access Token.

## Project Structure

### Directory Layout
Expand Down