-
+
```json
{
"servers": {
@@ -130,7 +130,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
```bash
# CLI usage
claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT
-
+
# In config files (where supported)
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
@@ -144,6 +144,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
- **Minimum scopes**: Only grant necessary permissions
- `repo` - Repository operations
- `read:packages` - Docker image access
+ - `read:org` - Organization team access
- **Separate tokens**: Use different PATs for different projects/environments
- **Regular rotation**: Update tokens periodically
- **Never commit**: Keep tokens out of version control
@@ -240,10 +241,10 @@ For other MCP host applications, please refer to our installation guides:
- **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
- **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
-- **[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
+- **[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
- **[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
-For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides/installation-guides.md)**.
+For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
> **Note:** Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
@@ -294,6 +295,7 @@ The following sets of tools are available (all are on by default):
| `pull_requests` | GitHub Pull Request related tools |
| `repos` | GitHub Repository related tools |
| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning |
+| `security_advisories` | Security advisories related tools |
| `users` | GitHub User related tools |
@@ -421,6 +423,13 @@ The following sets of tools are available (all are on by default):
- **get_me** - Get my user profile
- No parameters required
+- **get_team_members** - Get team members
+ - `org`: Organization login (owner) that contains the team. (string, required)
+ - `team_slug`: Team slug (string, required)
+
+- **get_teams** - Get teams
+ - `user`: Username to get teams for. If not provided, uses the authenticated user. (string, optional)
+
@@ -525,6 +534,7 @@ The following sets of tools are available (all are on by default):
- `owner`: Repository owner (string, required)
- `repo`: Repository name (string, required)
- `title`: Issue title (string, required)
+ - `type`: Type of this issue (string, optional)
- **get_issue** - Get issue details
- `issue_number`: The number of the issue (number, required)
@@ -538,6 +548,9 @@ The following sets of tools are available (all are on by default):
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `repo`: Repository name (string, required)
+- **list_issue_types** - List available issue types
+ - `owner`: The organization owner of the repository (string, required)
+
- **list_issues** - List issues
- `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
- `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
@@ -589,6 +602,7 @@ The following sets of tools are available (all are on by default):
- `repo`: Repository name (string, required)
- `state`: New state (string, optional)
- `title`: New title (string, optional)
+ - `type`: New issue type (string, optional)
@@ -829,6 +843,15 @@ The following sets of tools are available (all are on by default):
- `repo`: Repository name (string, required)
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
+- **get_latest_release** - Get latest release
+ - `owner`: Repository owner (string, required)
+ - `repo`: Repository name (string, required)
+
+- **get_release_by_tag** - Get a release by tag name
+ - `owner`: Repository owner (string, required)
+ - `repo`: Repository name (string, required)
+ - `tag`: Tag name (e.g., 'v1.0.0') (string, required)
+
- **get_tag** - Get tag details
- `owner`: Repository owner (string, required)
- `repo`: Repository name (string, required)
@@ -848,6 +871,12 @@ The following sets of tools are available (all are on by default):
- `repo`: Repository name (string, required)
- `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)
+- **list_releases** - List releases
+ - `owner`: Repository owner (string, required)
+ - `page`: Page number for pagination (min 1) (number, optional)
+ - `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
+ - `repo`: Repository name (string, required)
+
- **list_tags** - List tags
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
@@ -895,6 +924,41 @@ The following sets of tools are available (all are on by default):
+Security Advisories
+
+- **get_global_security_advisory** - Get a global security advisory
+ - `ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required)
+
+- **list_global_security_advisories** - List global security advisories
+ - `affects`: Filter advisories by affected package or version (e.g. "package1,package2@1.0.0"). (string, optional)
+ - `cveId`: Filter by CVE ID. (string, optional)
+ - `cwes`: Filter by Common Weakness Enumeration IDs (e.g. ["79", "284", "22"]). (string[], optional)
+ - `ecosystem`: Filter by package ecosystem. (string, optional)
+ - `ghsaId`: Filter by GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, optional)
+ - `isWithdrawn`: Whether to only return withdrawn advisories. (boolean, optional)
+ - `modified`: Filter by publish or update date or date range (ISO 8601 date or range). (string, optional)
+ - `published`: Filter by publish date or date range (ISO 8601 date or range). (string, optional)
+ - `severity`: Filter by severity. (string, optional)
+ - `type`: Advisory type. (string, optional)
+ - `updated`: Filter by update date or date range (ISO 8601 date or range). (string, optional)
+
+- **list_org_repository_security_advisories** - List org repository security advisories
+ - `direction`: Sort direction. (string, optional)
+ - `org`: The organization login. (string, required)
+ - `sort`: Sort field. (string, optional)
+ - `state`: Filter by advisory state. (string, optional)
+
+- **list_repository_security_advisories** - List repository security advisories
+ - `direction`: Sort direction. (string, optional)
+ - `owner`: The owner of the repository. (string, required)
+ - `repo`: The name of the repository. (string, required)
+ - `sort`: Sort field. (string, optional)
+ - `state`: Filter by advisory state. (string, optional)
+
+
+
+
+
Users
- **search_users** - Search users
@@ -1075,4 +1139,4 @@ The exported Go API of this module should currently be considered unstable, and
## License
-This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
\ No newline at end of file
+This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
diff --git a/cmd/github-mcp-server/generate_docs.go b/cmd/github-mcp-server/generate_docs.go
index 7fc62b1ae..89cc37c22 100644
--- a/cmd/github-mcp-server/generate_docs.go
+++ b/cmd/github-mcp-server/generate_docs.go
@@ -64,7 +64,7 @@ func generateReadmeDocs(readmePath string) error {
t, _ := translations.TranslationHelper()
// Create toolset group with mock clients
- tsg := github.DefaultToolsetGroup(false, mockGetClient, mockGetGQLClient, mockGetRawClient, t)
+ tsg := github.DefaultToolsetGroup(false, mockGetClient, mockGetGQLClient, mockGetRawClient, t, 5000)
// Generate toolsets documentation
toolsetsDoc := generateToolsetsDoc(tsg)
@@ -302,7 +302,7 @@ func generateRemoteToolsetsDoc() string {
t, _ := translations.TranslationHelper()
// Create toolset group with mock clients
- tsg := github.DefaultToolsetGroup(false, mockGetClient, mockGetGQLClient, mockGetRawClient, t)
+ tsg := github.DefaultToolsetGroup(false, mockGetClient, mockGetGQLClient, mockGetRawClient, t, 5000)
// Generate table header
buf.WriteString("| Name | Description | API URL | 1-Click Install (VS Code) | Read-only Link | 1-Click Read-only Install (VS Code) |\n")
diff --git a/cmd/github-mcp-server/main.go b/cmd/github-mcp-server/main.go
index cad002666..0a4545835 100644
--- a/cmd/github-mcp-server/main.go
+++ b/cmd/github-mcp-server/main.go
@@ -55,6 +55,7 @@ var (
ExportTranslations: viper.GetBool("export-translations"),
EnableCommandLogging: viper.GetBool("enable-command-logging"),
LogFilePath: viper.GetString("log-file"),
+ ContentWindowSize: viper.GetInt("content-window-size"),
}
return ghmcp.RunStdioServer(stdioServerConfig)
},
@@ -75,6 +76,7 @@ func init() {
rootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
rootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
rootCmd.PersistentFlags().String("gh-host", "", "Specify the GitHub hostname (for GitHub Enterprise etc.)")
+ rootCmd.PersistentFlags().Int("content-window-size", 5000, "Specify the content window size")
// Bind flag to viper
_ = viper.BindPFlag("toolsets", rootCmd.PersistentFlags().Lookup("toolsets"))
@@ -84,6 +86,7 @@ func init() {
_ = viper.BindPFlag("enable-command-logging", rootCmd.PersistentFlags().Lookup("enable-command-logging"))
_ = viper.BindPFlag("export-translations", rootCmd.PersistentFlags().Lookup("export-translations"))
_ = viper.BindPFlag("host", rootCmd.PersistentFlags().Lookup("gh-host"))
+ _ = viper.BindPFlag("content-window-size", rootCmd.PersistentFlags().Lookup("content-window-size"))
// Add subcommands
rootCmd.AddCommand(stdioCmd)
diff --git a/docs/installation-guides/install-claude.md b/docs/installation-guides/install-claude.md
index 2c50be2f9..1a5b789f4 100644
--- a/docs/installation-guides/install-claude.md
+++ b/docs/installation-guides/install-claude.md
@@ -1,124 +1,98 @@
# Install GitHub MCP Server in Claude Applications
-This guide covers installation of the GitHub MCP server for Claude Code CLI, Claude Desktop, and Claude Web applications.
-
-## Claude Web (claude.ai)
-
-Claude Web supports remote MCP servers through the Integrations built-in feature.
+## Claude Code CLI
### Prerequisites
+- Claude Code CLI installed
+- [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
+- For local setup: [Docker](https://www.docker.com/) installed and running
+- Open Claude Code inside the directory for your project (recommended for best experience and clear scope of configuration)
-1. Claude Pro, Team, or Enterprise account (Integrations not available on free plan)
-2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
-
-### Installation
-
-**Note**: As of July 2025, the remote GitHub MCP Server has known compatibility issues with Claude Web. While Claude Web supports remote MCP servers from other providers (like Atlassian, Zapier, Notion), the GitHub MCP Server integration may not work reliably.
-
-For other remote MCP servers that do work with Claude Web:
-
-1. Go to [claude.ai](https://claude.ai) and log in
-2. Click your profile icon → **Settings**
-3. Navigate to **Integrations** section
-4. Click **+ Add integration** or **Add More**
-5. Enter the remote server URL
-6. Follow the OAuth authentication flow when prompted
+
+Storing Your PAT Securely
+
-**Alternative**: Use Claude Desktop or Claude Code CLI for reliable GitHub MCP Server integration.
+For security, avoid hardcoding your token. One common approach:
----
-
-## Claude Code CLI
-
-Claude Code CLI provides command-line access to Claude with MCP server integration.
-
-### Prerequisites
+1. Store your token in `.env` file
+```
+GITHUB_PAT=your_token_here
+```
-1. Claude Code CLI installed
-2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
-3. [Docker](https://www.docker.com/) installed and running
+2. Add to .gitignore
+```bash
+echo -e ".env\n.mcp.json" >> .gitignore
+```
-### Installation
+
-Run the following command to add the GitHub MCP server using Docker:
+### Remote Server Setup (Streamable HTTP)
+1. Run the following command in the Claude Code CLI
```bash
-claude mcp add github -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
+claude mcp add --transport http github https://api.githubcopilot.com/mcp -H "Authorization: Bearer YOUR_GITHUB_PAT"
```
-Then set the environment variable:
+With an environment variable:
```bash
-claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=your_github_pat
+claude mcp add --transport http github https://api.githubcopilot.com/mcp -H "Authorization: Bearer $(grep GITHUB_PAT .env | cut -d '=' -f2)"
```
+2. Restart Claude Code
+3. Run `claude mcp list` to see if the GitHub server is configured
+
+### Local Server Setup (Docker required)
-Or as a single command with the token inline:
+### With Docker
+1. Run the following command in the Claude Code CLI:
```bash
-claude mcp add-json github '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"}}'
+claude mcp add github -e GITHUB_PERSONAL_ACCESS_TOKEN=YOUR_GITHUB_PAT -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
```
-**Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.
+With an environment variable:
+```bash
+claude mcp add github -e GITHUB_PERSONAL_ACCESS_TOKEN=$(grep GITHUB_PAT .env | cut -d '=' -f2) -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
+```
+2. Restart Claude Code
+3. Run `claude mcp list` to see if the GitHub server is configured
-### Configuration Options
+### With a Binary (no Docker)
-- Use `-s user` to add the server to your user configuration (available across all projects)
-- Use `-s project` to add the server to project-specific configuration (shared via `.mcp.json`)
-- Default scope is `local` (available only to you in the current project)
+1. Download [release binary](https://github.com/github/github-mcp-server/releases)
+2. Add to your `PATH`
+3. Run:
+```bash
+claude mcp add-json github '{"command": "github-mcp-server", "args": ["stdio"], "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"}}'
+```
+2. Restart Claude Code
+3. Run `claude mcp list` to see if the GitHub server is configured
### Verification
-
-Run the following command to verify the installation:
```bash
claude mcp list
+claude mcp get github
```
---
## Claude Desktop
-Claude Desktop provides a graphical interface for interacting with the GitHub MCP Server.
+> ⚠️ **Note**: Some users have reported compatibility issues with Claude Desktop and Docker-based MCP servers. We're investigating. If you experience issues, try using another MCP host, while we look into it!
### Prerequisites
+- Claude Desktop installed (latest version)
+- [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
+- [Docker](https://www.docker.com/) installed and running
-1. Claude Desktop installed
-2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
-3. [Docker](https://www.docker.com/) installed and running
+> **Note**: Claude Desktop supports MCP servers that are both local (stdio) and remote ("connectors"). Remote servers can generally be added via Settings → Connectors → "Add custom connector". However, the GitHub remote MCP server requires OAuth authentication through a registered GitHub App (or OAuth App), which is not currently supported. Use the local Docker setup instead.
### Configuration File Location
-
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
-- **Linux**: `~/.config/Claude/claude_desktop_config.json` (unofficial support)
-
-### Installation
-
-Add the following to your `claude_desktop_config.json`:
-
-```json
-{
- "mcpServers": {
- "github": {
- "command": "docker",
- "args": [
- "run",
- "-i",
- "--rm",
- "-e",
- "GITHUB_PERSONAL_ACCESS_TOKEN",
- "ghcr.io/github/github-mcp-server"
- ],
- "env": {
- "GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat"
- }
- }
- }
-}
-```
+- **Linux**: `~/.config/Claude/claude_desktop_config.json`
-**Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.
+### Local Server Setup (Docker)
-### Using Environment Variables
-
-Claude Desktop supports environment variable references. You can use:
+Add this codeblock to your `claude_desktop_config.json`:
```json
{
@@ -134,71 +108,60 @@ Claude Desktop supports environment variable references. You can use:
"ghcr.io/github/github-mcp-server"
],
"env": {
- "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
+ "GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
}
}
}
}
```
-Then set the environment variable in your system before starting Claude Desktop.
-
-### Installation Steps
-
+### Manual Setup Steps
1. Open Claude Desktop
-2. Go to Settings (from the Claude menu) → Developer → Edit Config
-3. Add your chosen configuration
-4. Save the file
-5. Restart Claude Desktop
-
-### Verification
-
-After restarting, you should see:
-- An MCP icon in the Claude Desktop interface
-- The GitHub server listed as "running" in Developer settings
+2. Go to Settings → Developer → Edit Config
+3. Paste the code block above in your configuration file
+4. If you're navigating to the configuration file outside of the app:
+ - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+ - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+5. Open the file in a text editor
+6. Paste one of the code blocks above, based on your chosen configuration (remote or local)
+7. Replace `YOUR_GITHUB_PAT` with your actual token or $GITHUB_PAT environment variable
+8. Save the file
+9. Restart Claude Desktop
---
## Troubleshooting
-### Claude Web
-- Currently experiencing compatibility issues with the GitHub MCP Server
-- Try other remote MCP servers (Atlassian, Zapier, Notion) which work reliably
-- Use Claude Desktop or Claude Code CLI as alternatives for GitHub integration
-
-### Claude Code CLI
-- Verify the command syntax is correct (note the single quotes around the JSON)
-- Ensure Docker is running: `docker --version`
-- Use `/mcp` command within Claude Code to check server status
-
-### Claude Desktop
-- Check logs at:
- - **macOS**: `~/Library/Logs/Claude/`
- - **Windows**: `%APPDATA%\Claude\logs\`
-- Look for `mcp-server-github.log` for server-specific errors
-- Ensure configuration file is valid JSON
-- Try running the Docker command manually in terminal to diagnose issues
-
-### Common Issues
-- **Invalid JSON**: Validate your configuration at [jsonlint.com](https://jsonlint.com)
-- **PAT issues**: Ensure your GitHub PAT has required scopes
-- **Docker not found**: Install Docker Desktop and ensure it's running
-- **Docker image pull fails**: Try `docker logout ghcr.io` then retry
-
----
-
-## Security Best Practices
-
-- **Protect configuration files**: Set appropriate file permissions
-- **Use environment variables** when possible instead of hardcoding tokens
-- **Limit PAT scope** to only necessary permissions
-- **Regularly rotate** your GitHub Personal Access Tokens
-- **Never commit** configuration files containing tokens to version control
+**Authentication Failed:**
+- Verify PAT has `repo` scope
+- Check token hasn't expired
+
+**Remote Server:**
+- Verify URL: `https://api.githubcopilot.com/mcp`
+
+**Docker Issues (Local Only):**
+- Ensure Docker Desktop is running
+- Try: `docker pull ghcr.io/github/github-mcp-server`
+- If pull fails: `docker logout ghcr.io` then retry
+
+**Server Not Starting / Tools Not Showing:**
+- Run `claude mcp list` to view currently configured MCP servers
+- Validate JSON syntax
+- If using an environment variable to store your PAT, make sure you're properly sourcing your PAT using the environment variable
+- Restart Claude Code and check `/mcp` command
+- Delete the GitHub server by running `claude mcp remove github` and repeating the setup process with a different method
+- Make sure you're running Claude Code within the project you're currently working on to ensure the MCP configuration is properly scoped to your project
+- Check logs:
+ - Claude Code: Use `/mcp` command
+ - Claude Desktop: `ls ~/Library/Logs/Claude/` and `cat ~/Library/Logs/Claude/mcp-server-*.log` (macOS) or `%APPDATA%\Claude\logs\` (Windows)
---
-## Additional Resources
+## Important Notes
-- [Model Context Protocol Documentation](https://modelcontextprotocol.io)
-- [Claude Code MCP Documentation](https://docs.anthropic.com/en/docs/claude-code/mcp)
-- [Claude Web Integrations Support](https://support.anthropic.com/en/articles/11175166-about-custom-integrations-using-remote-mcp)
+- The npm package `@modelcontextprotocol/server-github` is deprecated as of April 2025
+- Remote server requires Streamable HTTP support (check your Claude version)
+- Configuration scopes for Claude Code:
+ - `-s user`: Available across all projects
+ - `-s project`: Shared via `.mcp.json` file
+ - Default: `local` (current project only)
diff --git a/docs/installation-guides/install-cursor.md b/docs/installation-guides/install-cursor.md
index b069addd3..654f0a788 100644
--- a/docs/installation-guides/install-cursor.md
+++ b/docs/installation-guides/install-cursor.md
@@ -1,17 +1,19 @@
# Install GitHub MCP Server in Cursor
## Prerequisites
+
1. Cursor IDE installed (latest version)
2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes
3. For local installation: [Docker](https://www.docker.com/) installed and running
## Remote Server Setup (Recommended)
-[](https://cursor.com/install-mcp?name=github&config=eyJ1cmwiOiJodHRwczovL2FwaS5naXRodWJjb3BpbG90LmNvbS9tY3AvIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfR0lUSFVCX1BBVCJ9LCJ0eXBlIjoiaHR0cCJ9)
+[](https://cursor.com/en/install-mcp?name=github&config=eyJ1cmwiOiJodHRwczovL2FwaS5naXRodWJjb3BpbG90LmNvbS9tY3AvIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfR0lUSFVCX1BBVCJ9fQ%3D%3D)
Uses GitHub's hosted server at https://api.githubcopilot.com/mcp/. Requires Cursor v0.48.0+ for Streamable HTTP support. While Cursor supports OAuth for some MCP servers, the GitHub server currently requires a Personal Access Token.
### Install steps
+
1. Click the install button above and follow the flow, or go directly to your global MCP configuration file at `~/.cursor/mcp.json` and enter the code block below
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
@@ -35,11 +37,12 @@ Uses GitHub's hosted server at https://api.githubcopilot.com/mcp/. Requires Curs
## Local Server Setup
-[](https://cursor.com/install-mcp?name=github&config=eyJjb21tYW5kIjoiZG9ja2VyIiwiYXJncyI6WyJydW4iLCItaSIsIi0tcm0iLCItZSIsIkdJVEhVQl9QRVJTT05BTF9BQ0NFU1NfVE9LRU4iLCJnaGNyLmlvL2dpdGh1Yi9naXRodWItbWNwLXNlcnZlciJdLCJlbnYiOnsiR0lUSFVCX1BFUlNPTkFMX0FDQ0VTU19UT0tFTiI6IllPVVJfR0lUSFVCX1BHVCJ9fQ==)
+[](https://cursor.com/en/install-mcp?name=github&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIEdJVEhVQl9QRVJTT05BTF9BQ0NFU1NfVE9LRU4gZ2hjci5pby9naXRodWIvZ2l0aHViLW1jcC1zZXJ2ZXIiLCJlbnYiOnsiR0lUSFVCX1BFUlNPTkFMX0FDQ0VTU19UT0tFTiI6IllPVVJfR0lUSFVCX1BBVCJ9fQ%3D%3D)
The local GitHub MCP server runs via Docker and requires Docker Desktop to be installed and running.
### Install steps
+
1. Click the install button above and follow the flow, or go directly to your global MCP configuration file at `~/.cursor/mcp.json` and enter the code block below
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
@@ -77,6 +80,7 @@ The local GitHub MCP server runs via Docker and requires Docker Desktop to be in
- **Project-specific**: `.cursor/mcp.json` in project root
## Verify Installation
+
1. Restart Cursor completely
2. Check for green dot in Settings → Tools & Integrations → MCP Tools
3. In chat/composer, check "Available Tools"
@@ -85,16 +89,19 @@ The local GitHub MCP server runs via Docker and requires Docker Desktop to be in
## Troubleshooting
### Remote Server Issues
+
- **Streamable HTTP not working**: Ensure you're using Cursor v0.48.0 or later
- **Authentication failures**: Verify PAT has correct scopes
- **Connection errors**: Check firewall/proxy settings
### Local Server Issues
+
- **Docker errors**: Ensure Docker Desktop is running
- **Image pull failures**: Try `docker logout ghcr.io` then retry
- **Docker not found**: Install Docker Desktop and ensure it's running
### General Issues
+
- **MCP not loading**: Restart Cursor completely after configuration
- **Invalid JSON**: Validate that json format is correct
- **Tools not appearing**: Check server shows green dot in MCP settings
diff --git a/docs/remote-server.md b/docs/remote-server.md
index 5f57f4961..b6f7fa61d 100644
--- a/docs/remote-server.md
+++ b/docs/remote-server.md
@@ -32,6 +32,7 @@ Below is a table of available toolsets for the remote GitHub MCP Server. Each to
| Pull Requests | GitHub Pull Request related tools | https://api.githubcopilot.com/mcp/x/pull_requests | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-pull_requests&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fpull_requests%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/pull_requests/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-pull_requests&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fpull_requests%2Freadonly%22%7D) |
| Repositories | GitHub Repository related tools | https://api.githubcopilot.com/mcp/x/repos | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-repos&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Frepos%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/repos/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-repos&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Frepos%2Freadonly%22%7D) |
| Secret Protection | Secret protection related tools, such as GitHub Secret Scanning | https://api.githubcopilot.com/mcp/x/secret_protection | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-secret_protection&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecret_protection%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/secret_protection/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-secret_protection&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecret_protection%2Freadonly%22%7D) |
+| Security Advisories | Security advisories related tools | https://api.githubcopilot.com/mcp/x/security_advisories | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-security_advisories&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecurity_advisories%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/security_advisories/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-security_advisories&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecurity_advisories%2Freadonly%22%7D) |
| Users | GitHub User related tools | https://api.githubcopilot.com/mcp/x/users | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-users&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fusers%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/users/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-users&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fusers%2Freadonly%22%7D) |
diff --git a/github-mcp-server b/github-mcp-server
new file mode 100755
index 000000000..864242c24
Binary files /dev/null and b/github-mcp-server differ
diff --git a/go.mod b/go.mod
index 5f114825d..b566e6c40 100644
--- a/go.mod
+++ b/go.mod
@@ -5,19 +5,22 @@ go 1.23.7
require (
github.com/google/go-github/v74 v74.0.0
github.com/josephburnett/jd v1.9.2
- github.com/mark3labs/mcp-go v0.32.0
+ github.com/mark3labs/mcp-go v0.36.0
github.com/migueleliasweb/go-github-mock v1.3.0
- github.com/sirupsen/logrus v1.9.3
github.com/spf13/cobra v1.9.1
github.com/spf13/viper v1.20.1
github.com/stretchr/testify v1.10.0
)
require (
+ github.com/bahlo/generic-list-go v0.2.0 // indirect
+ github.com/buger/jsonparser v1.1.1 // indirect
github.com/go-openapi/jsonpointer v0.19.5 // indirect
github.com/go-openapi/swag v0.21.1 // indirect
+ github.com/invopop/jsonschema v0.13.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/mailru/easyjson v0.7.7 // indirect
+ github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82 // indirect
golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
diff --git a/go.sum b/go.sum
index 64ce05453..24377c8aa 100644
--- a/go.sum
+++ b/go.sum
@@ -1,3 +1,7 @@
+github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
+github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
+github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
+github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -30,6 +34,8 @@ github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/invopop/jsonschema v0.13.0 h1:KvpoAJWEjR3uD9Kbm2HWJmqsEaHt8lBUpd0qHcIi21E=
+github.com/invopop/jsonschema v0.13.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0=
github.com/josephburnett/jd v1.9.2 h1:ECJRRFXCCqbtidkAHckHGSZm/JIaAxS1gygHLF8MI5Y=
github.com/josephburnett/jd v1.9.2/go.mod h1:bImDr8QXpxMb3SD+w1cDRHp97xP6UwI88xUAuxwDQfM=
github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
@@ -47,8 +53,8 @@ github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN
github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
-github.com/mark3labs/mcp-go v0.32.0 h1:fgwmbfL2gbd67obg57OfV2Dnrhs1HtSdlY/i5fn7MU8=
-github.com/mark3labs/mcp-go v0.32.0/go.mod h1:rXqOudj/djTORU/ThxYx8fqEVj/5pvTuuebQ2RC7uk4=
+github.com/mark3labs/mcp-go v0.36.0 h1:rIZaijrRYPeSbJG8/qNDe0hWlGrCJ7FWHNMz2SQpTis=
+github.com/mark3labs/mcp-go v0.36.0/go.mod h1:T7tUa2jO6MavG+3P25Oy/jR7iCeJPHImCZHRymCn39g=
github.com/migueleliasweb/go-github-mock v1.3.0 h1:2sVP9JEMB2ubQw1IKto3/fzF51oFC6eVWOOFDgQoq88=
github.com/migueleliasweb/go-github-mock v1.3.0/go.mod h1:ipQhV8fTcj/G6m7BKzin08GaJ/3B5/SonRAkgrk0zCY=
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
@@ -66,8 +72,6 @@ github.com/shurcooL/githubv4 v0.0.0-20240727222349-48295856cce7 h1:cYCy18SHPKRkv
github.com/shurcooL/githubv4 v0.0.0-20240727222349-48295856cce7/go.mod h1:zqMwyHmnN/eDOZOdiTohqIUKUrTFX62PNlu7IJdu0q8=
github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 h1:17JxqqJY66GmZVHkmAsGEkcIu0oCe3AM420QDgGwZx0=
github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466/go.mod h1:9dIRpgIY7hVhoqfe0/FcYp0bpInZaT7dc3BYOprrIUE=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo=
github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0=
github.com/spf13/afero v1.14.0 h1:9tH6MapGnn/j0eb0yIXiLjERO8RB6xIVZRDCX7PtqWA=
@@ -83,11 +87,12 @@ github.com/spf13/viper v1.20.1/go.mod h1:P9Mdzt1zoHIG8m2eZQinpiBjo6kCmZSKBClNNqj
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
+github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc=
+github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw=
github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82 h1:BHyfKlQyqbsFN5p3IfnEUduWvb9is428/nNb5L3U01M=
@@ -98,7 +103,6 @@ golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0
golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY=
golang.org/x/oauth2 v0.29.0 h1:WdYw2tdTK1S8olAzWHdgeqfy+Mtm9XNhv/xJsY65d98=
golang.org/x/oauth2 v0.29.0/go.mod h1:onh5ek6nERTohokkhCD/y2cV4Do3fxFHFuAejCkRWT8=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=
diff --git a/internal/ghmcp/server.go b/internal/ghmcp/server.go
index 5079ab847..7ad71532f 100644
--- a/internal/ghmcp/server.go
+++ b/internal/ghmcp/server.go
@@ -5,6 +5,7 @@ import (
"fmt"
"io"
"log"
+ "log/slog"
"net/http"
"net/url"
"os"
@@ -21,7 +22,6 @@ import (
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
"github.com/shurcooL/githubv4"
- "github.com/sirupsen/logrus"
)
type MCPServerConfig struct {
@@ -47,8 +47,13 @@ type MCPServerConfig struct {
// Translator provides translated text for the server tooling
Translator translations.TranslationHelperFunc
+
+ // Content window size
+ ContentWindowSize int
}
+const stdioServerLogPrefix = "stdioserver"
+
func NewMCPServer(cfg MCPServerConfig) (*server.MCPServer, error) {
apiHost, err := parseAPIHost(cfg.Host)
if err != nil {
@@ -130,7 +135,7 @@ func NewMCPServer(cfg MCPServerConfig) (*server.MCPServer, error) {
}
// Create default toolsets
- tsg := github.DefaultToolsetGroup(cfg.ReadOnly, getClient, getGQLClient, getRawClient, cfg.Translator)
+ tsg := github.DefaultToolsetGroup(cfg.ReadOnly, getClient, getGQLClient, getRawClient, cfg.Translator, cfg.ContentWindowSize)
err = tsg.EnableToolsets(enabledToolsets)
if err != nil {
@@ -178,6 +183,9 @@ type StdioServerConfig struct {
// Path to the log file if not stderr
LogFilePath string
+
+ // Content window size
+ ContentWindowSize int
}
// RunStdioServer is not concurrent safe.
@@ -189,13 +197,14 @@ func RunStdioServer(cfg StdioServerConfig) error {
t, dumpTranslations := translations.TranslationHelper()
ghServer, err := NewMCPServer(MCPServerConfig{
- Version: cfg.Version,
- Host: cfg.Host,
- Token: cfg.Token,
- EnabledToolsets: cfg.EnabledToolsets,
- DynamicToolsets: cfg.DynamicToolsets,
- ReadOnly: cfg.ReadOnly,
- Translator: t,
+ Version: cfg.Version,
+ Host: cfg.Host,
+ Token: cfg.Token,
+ EnabledToolsets: cfg.EnabledToolsets,
+ DynamicToolsets: cfg.DynamicToolsets,
+ ReadOnly: cfg.ReadOnly,
+ Translator: t,
+ ContentWindowSize: cfg.ContentWindowSize,
})
if err != nil {
return fmt.Errorf("failed to create MCP server: %w", err)
@@ -203,17 +212,22 @@ func RunStdioServer(cfg StdioServerConfig) error {
stdioServer := server.NewStdioServer(ghServer)
- logrusLogger := logrus.New()
+ var slogHandler slog.Handler
+ var logOutput io.Writer
if cfg.LogFilePath != "" {
file, err := os.OpenFile(cfg.LogFilePath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
if err != nil {
return fmt.Errorf("failed to open log file: %w", err)
}
-
- logrusLogger.SetLevel(logrus.DebugLevel)
- logrusLogger.SetOutput(file)
- }
- stdLogger := log.New(logrusLogger.Writer(), "stdioserver", 0)
+ logOutput = file
+ slogHandler = slog.NewTextHandler(logOutput, &slog.HandlerOptions{Level: slog.LevelDebug})
+ } else {
+ logOutput = os.Stderr
+ slogHandler = slog.NewTextHandler(logOutput, &slog.HandlerOptions{Level: slog.LevelInfo})
+ }
+ logger := slog.New(slogHandler)
+ logger.Info("starting server", "version", cfg.Version, "host", cfg.Host, "dynamicToolsets", cfg.DynamicToolsets, "readOnly", cfg.ReadOnly)
+ stdLogger := log.New(logOutput, stdioServerLogPrefix, 0)
stdioServer.SetErrorLogger(stdLogger)
if cfg.ExportTranslations {
@@ -227,7 +241,7 @@ func RunStdioServer(cfg StdioServerConfig) error {
in, out := io.Reader(os.Stdin), io.Writer(os.Stdout)
if cfg.EnableCommandLogging {
- loggedIO := mcplog.NewIOLogger(in, out, logrusLogger)
+ loggedIO := mcplog.NewIOLogger(in, out, logger)
in, out = loggedIO, loggedIO
}
// enable GitHub errors in the context
@@ -241,9 +255,10 @@ func RunStdioServer(cfg StdioServerConfig) error {
// Wait for shutdown signal
select {
case <-ctx.Done():
- logrusLogger.Infof("shutting down server...")
+ logger.Info("shutting down server", "signal", "context done")
case err := <-errC:
if err != nil {
+ logger.Error("error running server", "error", err)
return fmt.Errorf("error running server: %w", err)
}
}
diff --git a/internal/profiler/profiler.go b/internal/profiler/profiler.go
new file mode 100644
index 000000000..1cfb7ffae
--- /dev/null
+++ b/internal/profiler/profiler.go
@@ -0,0 +1,215 @@
+package profiler
+
+import (
+ "context"
+ "fmt"
+ "os"
+ "runtime"
+ "strconv"
+ "time"
+
+ "log/slog"
+ "math"
+)
+
+// Profile represents performance metrics for an operation
+type Profile struct {
+ Operation string `json:"operation"`
+ Duration time.Duration `json:"duration_ns"`
+ MemoryBefore uint64 `json:"memory_before_bytes"`
+ MemoryAfter uint64 `json:"memory_after_bytes"`
+ MemoryDelta int64 `json:"memory_delta_bytes"`
+ LinesCount int `json:"lines_count,omitempty"`
+ BytesCount int64 `json:"bytes_count,omitempty"`
+ Timestamp time.Time `json:"timestamp"`
+}
+
+// String returns a human-readable representation of the profile
+func (p *Profile) String() string {
+ return fmt.Sprintf("[%s] %s: duration=%v, memory_delta=%+dB, lines=%d, bytes=%d",
+ p.Timestamp.Format("15:04:05.000"),
+ p.Operation,
+ p.Duration,
+ p.MemoryDelta,
+ p.LinesCount,
+ p.BytesCount,
+ )
+}
+
+func safeMemoryDelta(after, before uint64) int64 {
+ if after > math.MaxInt64 || before > math.MaxInt64 {
+ if after >= before {
+ diff := after - before
+ if diff > math.MaxInt64 {
+ return math.MaxInt64
+ }
+ return int64(diff)
+ }
+ diff := before - after
+ if diff > math.MaxInt64 {
+ return -math.MaxInt64
+ }
+ return -int64(diff)
+ }
+
+ return int64(after) - int64(before)
+}
+
+// Profiler provides minimal performance profiling capabilities
+type Profiler struct {
+ logger *slog.Logger
+ enabled bool
+}
+
+// New creates a new Profiler instance
+func New(logger *slog.Logger, enabled bool) *Profiler {
+ return &Profiler{
+ logger: logger,
+ enabled: enabled,
+ }
+}
+
+// ProfileFunc profiles a function execution
+func (p *Profiler) ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) {
+ if !p.enabled {
+ return nil, fn()
+ }
+
+ profile := &Profile{
+ Operation: operation,
+ Timestamp: time.Now(),
+ }
+
+ var memBefore runtime.MemStats
+ runtime.ReadMemStats(&memBefore)
+ profile.MemoryBefore = memBefore.Alloc
+
+ start := time.Now()
+ err := fn()
+ profile.Duration = time.Since(start)
+
+ var memAfter runtime.MemStats
+ runtime.ReadMemStats(&memAfter)
+ profile.MemoryAfter = memAfter.Alloc
+ profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc)
+
+ if p.logger != nil {
+ p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String())
+ }
+
+ return profile, err
+}
+
+// ProfileFuncWithMetrics profiles a function execution and captures additional metrics
+func (p *Profiler) ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) {
+ if !p.enabled {
+ _, _, err := fn()
+ return nil, err
+ }
+
+ profile := &Profile{
+ Operation: operation,
+ Timestamp: time.Now(),
+ }
+
+ var memBefore runtime.MemStats
+ runtime.ReadMemStats(&memBefore)
+ profile.MemoryBefore = memBefore.Alloc
+
+ start := time.Now()
+ lines, bytes, err := fn()
+ profile.Duration = time.Since(start)
+ profile.LinesCount = lines
+ profile.BytesCount = bytes
+
+ var memAfter runtime.MemStats
+ runtime.ReadMemStats(&memAfter)
+ profile.MemoryAfter = memAfter.Alloc
+ profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc)
+
+ if p.logger != nil {
+ p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String())
+ }
+
+ return profile, err
+}
+
+// Start begins timing an operation and returns a function to complete the profiling
+func (p *Profiler) Start(ctx context.Context, operation string) func(lines int, bytes int64) *Profile {
+ if !p.enabled {
+ return func(int, int64) *Profile { return nil }
+ }
+
+ profile := &Profile{
+ Operation: operation,
+ Timestamp: time.Now(),
+ }
+
+ var memBefore runtime.MemStats
+ runtime.ReadMemStats(&memBefore)
+ profile.MemoryBefore = memBefore.Alloc
+
+ start := time.Now()
+
+ return func(lines int, bytes int64) *Profile {
+ profile.Duration = time.Since(start)
+ profile.LinesCount = lines
+ profile.BytesCount = bytes
+
+ var memAfter runtime.MemStats
+ runtime.ReadMemStats(&memAfter)
+ profile.MemoryAfter = memAfter.Alloc
+ profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc)
+
+ if p.logger != nil {
+ p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String())
+ }
+
+ return profile
+ }
+}
+
+var globalProfiler *Profiler
+
+// IsProfilingEnabled checks if profiling is enabled via environment variables
+func IsProfilingEnabled() bool {
+ if enabled, err := strconv.ParseBool(os.Getenv("GITHUB_MCP_PROFILING_ENABLED")); err == nil {
+ return enabled
+ }
+ return false
+}
+
+// Init initializes the global profiler
+func Init(logger *slog.Logger, enabled bool) {
+ globalProfiler = New(logger, enabled)
+}
+
+// InitFromEnv initializes the global profiler using environment variables
+func InitFromEnv(logger *slog.Logger) {
+ globalProfiler = New(logger, IsProfilingEnabled())
+}
+
+// ProfileFunc profiles a function using the global profiler
+func ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) {
+ if globalProfiler == nil {
+ return nil, fn()
+ }
+ return globalProfiler.ProfileFunc(ctx, operation, fn)
+}
+
+// ProfileFuncWithMetrics profiles a function with metrics using the global profiler
+func ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) {
+ if globalProfiler == nil {
+ _, _, err := fn()
+ return nil, err
+ }
+ return globalProfiler.ProfileFuncWithMetrics(ctx, operation, fn)
+}
+
+// Start begins timing using the global profiler
+func Start(ctx context.Context, operation string) func(int, int64) *Profile {
+ if globalProfiler == nil {
+ return func(int, int64) *Profile { return nil }
+ }
+ return globalProfiler.Start(ctx, operation)
+}
diff --git a/pkg/buffer/buffer.go b/pkg/buffer/buffer.go
new file mode 100644
index 000000000..546b5324c
--- /dev/null
+++ b/pkg/buffer/buffer.go
@@ -0,0 +1,69 @@
+package buffer
+
+import (
+ "bufio"
+ "fmt"
+ "net/http"
+ "strings"
+)
+
+// ProcessResponseAsRingBufferToEnd reads the body of an HTTP response line by line,
+// storing only the last maxJobLogLines lines using a ring buffer (sliding window).
+// This efficiently retains the most recent lines, overwriting older ones as needed.
+//
+// Parameters:
+//
+// httpResp: The HTTP response whose body will be read.
+// maxJobLogLines: The maximum number of log lines to retain.
+//
+// Returns:
+//
+// string: The concatenated log lines (up to maxJobLogLines), separated by newlines.
+// int: The total number of lines read from the response.
+// *http.Response: The original HTTP response.
+// error: Any error encountered during reading.
+//
+// The function uses a ring buffer to efficiently store only the last maxJobLogLines lines.
+// If the response contains more lines than maxJobLogLines, only the most recent lines are kept.
+func ProcessResponseAsRingBufferToEnd(httpResp *http.Response, maxJobLogLines int) (string, int, *http.Response, error) {
+ lines := make([]string, maxJobLogLines)
+ validLines := make([]bool, maxJobLogLines)
+ totalLines := 0
+ writeIndex := 0
+
+ scanner := bufio.NewScanner(httpResp.Body)
+ scanner.Buffer(make([]byte, 0, 64*1024), 1024*1024)
+
+ for scanner.Scan() {
+ line := scanner.Text()
+ totalLines++
+
+ lines[writeIndex] = line
+ validLines[writeIndex] = true
+ writeIndex = (writeIndex + 1) % maxJobLogLines
+ }
+
+ if err := scanner.Err(); err != nil {
+ return "", 0, httpResp, fmt.Errorf("failed to read log content: %w", err)
+ }
+
+ var result []string
+ linesInBuffer := totalLines
+ if linesInBuffer > maxJobLogLines {
+ linesInBuffer = maxJobLogLines
+ }
+
+ startIndex := 0
+ if totalLines > maxJobLogLines {
+ startIndex = writeIndex
+ }
+
+ for i := 0; i < linesInBuffer; i++ {
+ idx := (startIndex + i) % maxJobLogLines
+ if validLines[idx] {
+ result = append(result, lines[idx])
+ }
+ }
+
+ return strings.Join(result, "\n"), totalLines, httpResp, nil
+}
diff --git a/pkg/github/__toolsnaps__/create_issue.snap b/pkg/github/__toolsnaps__/create_issue.snap
index f065b0183..d11c41c0e 100644
--- a/pkg/github/__toolsnaps__/create_issue.snap
+++ b/pkg/github/__toolsnaps__/create_issue.snap
@@ -39,6 +39,10 @@
"title": {
"description": "Issue title",
"type": "string"
+ },
+ "type": {
+ "description": "Type of this issue",
+ "type": "string"
}
},
"required": [
diff --git a/pkg/github/__toolsnaps__/get_release_by_tag.snap b/pkg/github/__toolsnaps__/get_release_by_tag.snap
new file mode 100644
index 000000000..c96d3c30a
--- /dev/null
+++ b/pkg/github/__toolsnaps__/get_release_by_tag.snap
@@ -0,0 +1,30 @@
+{
+ "annotations": {
+ "title": "Get a release by tag name",
+ "readOnlyHint": true
+ },
+ "description": "Get a specific release by its tag name in a GitHub repository",
+ "inputSchema": {
+ "properties": {
+ "owner": {
+ "description": "Repository owner",
+ "type": "string"
+ },
+ "repo": {
+ "description": "Repository name",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Tag name (e.g., 'v1.0.0')",
+ "type": "string"
+ }
+ },
+ "required": [
+ "owner",
+ "repo",
+ "tag"
+ ],
+ "type": "object"
+ },
+ "name": "get_release_by_tag"
+}
\ No newline at end of file
diff --git a/pkg/github/__toolsnaps__/get_team_members.snap b/pkg/github/__toolsnaps__/get_team_members.snap
new file mode 100644
index 000000000..2d91bb5ea
--- /dev/null
+++ b/pkg/github/__toolsnaps__/get_team_members.snap
@@ -0,0 +1,25 @@
+{
+ "annotations": {
+ "title": "Get team members",
+ "readOnlyHint": true
+ },
+ "description": "Get member usernames of a specific team in an organization. Limited to organizations accessible with current credentials",
+ "inputSchema": {
+ "properties": {
+ "org": {
+ "description": "Organization login (owner) that contains the team.",
+ "type": "string"
+ },
+ "team_slug": {
+ "description": "Team slug",
+ "type": "string"
+ }
+ },
+ "required": [
+ "org",
+ "team_slug"
+ ],
+ "type": "object"
+ },
+ "name": "get_team_members"
+}
\ No newline at end of file
diff --git a/pkg/github/__toolsnaps__/get_teams.snap b/pkg/github/__toolsnaps__/get_teams.snap
new file mode 100644
index 000000000..39ed4db35
--- /dev/null
+++ b/pkg/github/__toolsnaps__/get_teams.snap
@@ -0,0 +1,17 @@
+{
+ "annotations": {
+ "title": "Get teams",
+ "readOnlyHint": true
+ },
+ "description": "Get details of the teams the user is a member of. Limited to organizations accessible with current credentials",
+ "inputSchema": {
+ "properties": {
+ "user": {
+ "description": "Username to get teams for. If not provided, uses the authenticated user.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": "get_teams"
+}
\ No newline at end of file
diff --git a/pkg/github/__toolsnaps__/list_issue_types.snap b/pkg/github/__toolsnaps__/list_issue_types.snap
new file mode 100644
index 000000000..93c3e51d9
--- /dev/null
+++ b/pkg/github/__toolsnaps__/list_issue_types.snap
@@ -0,0 +1,20 @@
+{
+ "annotations": {
+ "title": "List available issue types",
+ "readOnlyHint": true
+ },
+ "description": "List supported issue types for repository owner (organization).",
+ "inputSchema": {
+ "properties": {
+ "owner": {
+ "description": "The organization owner of the repository",
+ "type": "string"
+ }
+ },
+ "required": [
+ "owner"
+ ],
+ "type": "object"
+ },
+ "name": "list_issue_types"
+}
\ No newline at end of file
diff --git a/pkg/github/__toolsnaps__/list_issues.snap b/pkg/github/__toolsnaps__/list_issues.snap
index f63da9c85..5475988c2 100644
--- a/pkg/github/__toolsnaps__/list_issues.snap
+++ b/pkg/github/__toolsnaps__/list_issues.snap
@@ -29,7 +29,8 @@
"description": "Order issues by field. If provided, the 'direction' also needs to be provided.",
"enum": [
"CREATED_AT",
- "UPDATED_AT"
+ "UPDATED_AT",
+ "COMMENTS"
],
"type": "string"
},
diff --git a/pkg/github/__toolsnaps__/update_issue.snap b/pkg/github/__toolsnaps__/update_issue.snap
index 4bcae7ba7..d95579159 100644
--- a/pkg/github/__toolsnaps__/update_issue.snap
+++ b/pkg/github/__toolsnaps__/update_issue.snap
@@ -51,6 +51,10 @@
"title": {
"description": "New title",
"type": "string"
+ },
+ "type": {
+ "description": "New issue type",
+ "type": "string"
}
},
"required": [
diff --git a/pkg/github/actions.go b/pkg/github/actions.go
index 12bbb3394..ace9d7288 100644
--- a/pkg/github/actions.go
+++ b/pkg/github/actions.go
@@ -4,11 +4,12 @@ import (
"context"
"encoding/json"
"fmt"
- "io"
"net/http"
"strconv"
"strings"
+ "github.com/github/github-mcp-server/internal/profiler"
+ buffer "github.com/github/github-mcp-server/pkg/buffer"
ghErrors "github.com/github/github-mcp-server/pkg/errors"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v74/github"
@@ -530,7 +531,7 @@ func ListWorkflowJobs(getClient GetClientFn, t translations.TranslationHelperFun
}
// GetJobLogs creates a tool to download logs for a specific workflow job or efficiently get all failed job logs for a workflow run
-func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc, contentWindowSize int) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("get_job_logs",
mcp.WithDescription(t("TOOL_GET_JOB_LOGS_DESCRIPTION", "Download logs for a specific workflow job or efficiently get all failed job logs for a workflow run")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
@@ -613,10 +614,10 @@ func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (to
if failedOnly && runID > 0 {
// Handle failed-only mode: get logs for all failed jobs in the workflow run
- return handleFailedJobLogs(ctx, client, owner, repo, int64(runID), returnContent, tailLines)
+ return handleFailedJobLogs(ctx, client, owner, repo, int64(runID), returnContent, tailLines, contentWindowSize)
} else if jobID > 0 {
// Handle single job mode
- return handleSingleJobLogs(ctx, client, owner, repo, int64(jobID), returnContent, tailLines)
+ return handleSingleJobLogs(ctx, client, owner, repo, int64(jobID), returnContent, tailLines, contentWindowSize)
}
return mcp.NewToolResultError("Either job_id must be provided for single job logs, or run_id with failed_only=true for failed job logs"), nil
@@ -624,7 +625,7 @@ func GetJobLogs(getClient GetClientFn, t translations.TranslationHelperFunc) (to
}
// handleFailedJobLogs gets logs for all failed jobs in a workflow run
-func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo string, runID int64, returnContent bool, tailLines int) (*mcp.CallToolResult, error) {
+func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo string, runID int64, returnContent bool, tailLines int, contentWindowSize int) (*mcp.CallToolResult, error) {
// First, get all jobs for the workflow run
jobs, resp, err := client.Actions.ListWorkflowJobs(ctx, owner, repo, runID, &github.ListWorkflowJobsOptions{
Filter: "latest",
@@ -656,7 +657,7 @@ func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo
// Collect logs for all failed jobs
var logResults []map[string]any
for _, job := range failedJobs {
- jobResult, resp, err := getJobLogData(ctx, client, owner, repo, job.GetID(), job.GetName(), returnContent, tailLines)
+ jobResult, resp, err := getJobLogData(ctx, client, owner, repo, job.GetID(), job.GetName(), returnContent, tailLines, contentWindowSize)
if err != nil {
// Continue with other jobs even if one fails
jobResult = map[string]any{
@@ -689,8 +690,8 @@ func handleFailedJobLogs(ctx context.Context, client *github.Client, owner, repo
}
// handleSingleJobLogs gets logs for a single job
-func handleSingleJobLogs(ctx context.Context, client *github.Client, owner, repo string, jobID int64, returnContent bool, tailLines int) (*mcp.CallToolResult, error) {
- jobResult, resp, err := getJobLogData(ctx, client, owner, repo, jobID, "", returnContent, tailLines)
+func handleSingleJobLogs(ctx context.Context, client *github.Client, owner, repo string, jobID int64, returnContent bool, tailLines int, contentWindowSize int) (*mcp.CallToolResult, error) {
+ jobResult, resp, err := getJobLogData(ctx, client, owner, repo, jobID, "", returnContent, tailLines, contentWindowSize)
if err != nil {
return ghErrors.NewGitHubAPIErrorResponse(ctx, "failed to get job logs", resp, err), nil
}
@@ -704,7 +705,7 @@ func handleSingleJobLogs(ctx context.Context, client *github.Client, owner, repo
}
// getJobLogData retrieves log data for a single job, either as URL or content
-func getJobLogData(ctx context.Context, client *github.Client, owner, repo string, jobID int64, jobName string, returnContent bool, tailLines int) (map[string]any, *github.Response, error) {
+func getJobLogData(ctx context.Context, client *github.Client, owner, repo string, jobID int64, jobName string, returnContent bool, tailLines int, contentWindowSize int) (map[string]any, *github.Response, error) {
// Get the download URL for the job logs
url, resp, err := client.Actions.GetWorkflowJobLogs(ctx, owner, repo, jobID, 1)
if err != nil {
@@ -721,7 +722,7 @@ func getJobLogData(ctx context.Context, client *github.Client, owner, repo strin
if returnContent {
// Download and return the actual log content
- content, originalLength, httpResp, err := downloadLogContent(url.String(), tailLines) //nolint:bodyclose // Response body is closed in downloadLogContent, but we need to return httpResp
+ content, originalLength, httpResp, err := downloadLogContent(ctx, url.String(), tailLines, contentWindowSize) //nolint:bodyclose // Response body is closed in downloadLogContent, but we need to return httpResp
if err != nil {
// To keep the return value consistent wrap the response as a GitHub Response
ghRes := &github.Response{
@@ -742,9 +743,11 @@ func getJobLogData(ctx context.Context, client *github.Client, owner, repo strin
return result, resp, nil
}
-// downloadLogContent downloads the actual log content from a GitHub logs URL
-func downloadLogContent(logURL string, tailLines int) (string, int, *http.Response, error) {
- httpResp, err := http.Get(logURL) //nolint:gosec // URLs are provided by GitHub API and are safe
+func downloadLogContent(ctx context.Context, logURL string, tailLines int, maxLines int) (string, int, *http.Response, error) {
+ prof := profiler.New(nil, profiler.IsProfilingEnabled())
+ finish := prof.Start(ctx, "log_buffer_processing")
+
+ httpResp, err := http.Get(logURL) //nolint:gosec
if err != nil {
return "", 0, httpResp, fmt.Errorf("failed to download logs: %w", err)
}
@@ -754,36 +757,25 @@ func downloadLogContent(logURL string, tailLines int) (string, int, *http.Respon
return "", 0, httpResp, fmt.Errorf("failed to download logs: HTTP %d", httpResp.StatusCode)
}
- content, err := io.ReadAll(httpResp.Body)
+ bufferSize := tailLines
+ if bufferSize > maxLines {
+ bufferSize = maxLines
+ }
+
+ processedInput, totalLines, httpResp, err := buffer.ProcessResponseAsRingBufferToEnd(httpResp, bufferSize)
if err != nil {
- return "", 0, httpResp, fmt.Errorf("failed to read log content: %w", err)
+ return "", 0, httpResp, fmt.Errorf("failed to process log content: %w", err)
}
- // Clean up and format the log content for better readability
- logContent := strings.TrimSpace(string(content))
+ lines := strings.Split(processedInput, "\n")
+ if len(lines) > tailLines {
+ lines = lines[len(lines)-tailLines:]
+ }
+ finalResult := strings.Join(lines, "\n")
- trimmedContent, lineCount := trimContent(logContent, tailLines)
- return trimmedContent, lineCount, httpResp, nil
-}
+ _ = finish(len(lines), int64(len(finalResult)))
-// trimContent trims the content to a maximum length and returns the trimmed content and an original length
-func trimContent(content string, tailLines int) (string, int) {
- // Truncate to tail_lines if specified
- lineCount := 0
- if tailLines > 0 {
-
- // Count backwards to find the nth newline from the end and a total number of lines
- for i := len(content) - 1; i >= 0 && lineCount < tailLines; i-- {
- if content[i] == '\n' {
- lineCount++
- // If we have reached the tailLines, trim the content
- if lineCount == tailLines {
- content = content[i+1:]
- }
- }
- }
- }
- return content, lineCount
+ return finalResult, totalLines, httpResp, nil
}
// RerunWorkflowRun creates a tool to re-run an entire workflow run
@@ -955,7 +947,9 @@ func CancelWorkflowRun(getClient GetClientFn, t translations.TranslationHelperFu
resp, err := client.Actions.CancelWorkflowRunByID(ctx, owner, repo, runID)
if err != nil {
- return ghErrors.NewGitHubAPIErrorResponse(ctx, "failed to cancel workflow run", resp, err), nil
+ if _, ok := err.(*github.AcceptedError); !ok {
+ return ghErrors.NewGitHubAPIErrorResponse(ctx, "failed to cancel workflow run", resp, err), nil
+ }
}
defer func() { _ = resp.Body.Close() }()
diff --git a/pkg/github/actions_test.go b/pkg/github/actions_test.go
index 58759dbd0..555ec04cb 100644
--- a/pkg/github/actions_test.go
+++ b/pkg/github/actions_test.go
@@ -3,10 +3,17 @@ package github
import (
"context"
"encoding/json"
+ "io"
"net/http"
"net/http/httptest"
+ "os"
+ "runtime"
+ "runtime/debug"
+ "strings"
"testing"
+ "github.com/github/github-mcp-server/internal/profiler"
+ buffer "github.com/github/github-mcp-server/pkg/buffer"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v74/github"
"github.com/migueleliasweb/go-github-mock/src/mock"
@@ -323,12 +330,14 @@ func Test_CancelWorkflowRun(t *testing.T) {
{
name: "successful workflow run cancellation",
mockedClient: mock.NewMockedHTTPClient(
- mock.WithRequestMatch(
+ mock.WithRequestMatchHandler(
mock.EndpointPattern{
Pattern: "/repos/owner/repo/actions/runs/12345/cancel",
Method: "POST",
},
- "", // Empty response body for 202 Accepted
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusAccepted)
+ }),
),
),
requestArgs: map[string]any{
@@ -338,6 +347,27 @@ func Test_CancelWorkflowRun(t *testing.T) {
},
expectError: false,
},
+ {
+ name: "conflict when cancelling a workflow run",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.EndpointPattern{
+ Pattern: "/repos/owner/repo/actions/runs/12345/cancel",
+ Method: "POST",
+ },
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusConflict)
+ }),
+ ),
+ ),
+ requestArgs: map[string]any{
+ "owner": "owner",
+ "repo": "repo",
+ "run_id": float64(12345),
+ },
+ expectError: true,
+ expectedErrMsg: "failed to cancel workflow run",
+ },
{
name: "missing required parameter run_id",
mockedClient: mock.NewMockedHTTPClient(),
@@ -369,7 +399,7 @@ func Test_CancelWorkflowRun(t *testing.T) {
textContent := getTextResult(t, result)
if tc.expectedErrMsg != "" {
- assert.Equal(t, tc.expectedErrMsg, textContent.Text)
+ assert.Contains(t, textContent.Text, tc.expectedErrMsg)
return
}
@@ -784,7 +814,7 @@ func Test_GetWorkflowRunUsage(t *testing.T) {
func Test_GetJobLogs(t *testing.T) {
// Verify tool definition once
mockClient := github.NewClient(nil)
- tool, _ := GetJobLogs(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+ tool, _ := GetJobLogs(stubGetClientFn(mockClient), translations.NullTranslationHelper, 5000)
assert.Equal(t, "get_job_logs", tool.Name)
assert.NotEmpty(t, tool.Description)
@@ -1013,7 +1043,7 @@ func Test_GetJobLogs(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := github.NewClient(tc.mockedClient)
- _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper)
+ _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper, 5000)
// Create call request
request := createMCPRequest(tc.requestArgs)
@@ -1072,7 +1102,7 @@ func Test_GetJobLogs_WithContentReturn(t *testing.T) {
)
client := github.NewClient(mockedClient)
- _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper)
+ _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper, 5000)
request := createMCPRequest(map[string]any{
"owner": "owner",
@@ -1119,7 +1149,7 @@ func Test_GetJobLogs_WithContentReturnAndTailLines(t *testing.T) {
)
client := github.NewClient(mockedClient)
- _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper)
+ _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper, 5000)
request := createMCPRequest(map[string]any{
"owner": "owner",
@@ -1139,8 +1169,153 @@ func Test_GetJobLogs_WithContentReturnAndTailLines(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, float64(123), response["job_id"])
- assert.Equal(t, float64(1), response["original_length"])
+ assert.Equal(t, float64(3), response["original_length"])
assert.Equal(t, expectedLogContent, response["logs_content"])
assert.Equal(t, "Job logs content retrieved successfully", response["message"])
assert.NotContains(t, response, "logs_url") // Should not have URL when returning content
}
+
+func Test_GetJobLogs_WithContentReturnAndLargeTailLines(t *testing.T) {
+ logContent := "Line 1\nLine 2\nLine 3"
+ expectedLogContent := "Line 1\nLine 2\nLine 3"
+
+ testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(logContent))
+ }))
+ defer testServer.Close()
+
+ mockedClient := mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposActionsJobsLogsByOwnerByRepoByJobId,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.Header().Set("Location", testServer.URL)
+ w.WriteHeader(http.StatusFound)
+ }),
+ ),
+ )
+
+ client := github.NewClient(mockedClient)
+ _, handler := GetJobLogs(stubGetClientFn(client), translations.NullTranslationHelper, 5000)
+
+ request := createMCPRequest(map[string]any{
+ "owner": "owner",
+ "repo": "repo",
+ "job_id": float64(123),
+ "return_content": true,
+ "tail_lines": float64(100),
+ })
+
+ result, err := handler(context.Background(), request)
+ require.NoError(t, err)
+ require.False(t, result.IsError)
+
+ textContent := getTextResult(t, result)
+ var response map[string]any
+ err = json.Unmarshal([]byte(textContent.Text), &response)
+ require.NoError(t, err)
+
+ assert.Equal(t, float64(123), response["job_id"])
+ assert.Equal(t, float64(3), response["original_length"])
+ assert.Equal(t, expectedLogContent, response["logs_content"])
+ assert.Equal(t, "Job logs content retrieved successfully", response["message"])
+ assert.NotContains(t, response, "logs_url")
+}
+
+func Test_MemoryUsage_SlidingWindow_vs_NoWindow(t *testing.T) {
+ if testing.Short() {
+ t.Skip("Skipping memory profiling test in short mode")
+ }
+
+ const logLines = 100000
+ const bufferSize = 5000
+ largeLogContent := strings.Repeat("log line with some content\n", logLines-1) + "final log line"
+
+ testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(largeLogContent))
+ }))
+ defer testServer.Close()
+
+ os.Setenv("GITHUB_MCP_PROFILING_ENABLED", "true")
+ defer os.Unsetenv("GITHUB_MCP_PROFILING_ENABLED")
+
+ profiler.InitFromEnv(nil)
+ ctx := context.Background()
+
+ debug.SetGCPercent(-1)
+ defer debug.SetGCPercent(100)
+
+ for i := 0; i < 3; i++ {
+ runtime.GC()
+ }
+
+ var baselineStats runtime.MemStats
+ runtime.ReadMemStats(&baselineStats)
+
+ profile1, err1 := profiler.ProfileFuncWithMetrics(ctx, "sliding_window", func() (int, int64, error) {
+ resp1, err := http.Get(testServer.URL)
+ if err != nil {
+ return 0, 0, err
+ }
+ defer resp1.Body.Close() //nolint:bodyclose
+ content, totalLines, _, err := buffer.ProcessResponseAsRingBufferToEnd(resp1, bufferSize) //nolint:bodyclose
+ return totalLines, int64(len(content)), err
+ })
+ require.NoError(t, err1)
+
+ for i := 0; i < 3; i++ {
+ runtime.GC()
+ }
+
+ profile2, err2 := profiler.ProfileFuncWithMetrics(ctx, "no_window", func() (int, int64, error) {
+ resp2, err := http.Get(testServer.URL)
+ if err != nil {
+ return 0, 0, err
+ }
+ defer resp2.Body.Close() //nolint:bodyclose
+
+ allContent, err := io.ReadAll(resp2.Body)
+ if err != nil {
+ return 0, 0, err
+ }
+
+ allLines := strings.Split(string(allContent), "\n")
+ var nonEmptyLines []string
+ for _, line := range allLines {
+ if line != "" {
+ nonEmptyLines = append(nonEmptyLines, line)
+ }
+ }
+ totalLines := len(nonEmptyLines)
+
+ var resultLines []string
+ if totalLines > bufferSize {
+ resultLines = nonEmptyLines[totalLines-bufferSize:]
+ } else {
+ resultLines = nonEmptyLines
+ }
+
+ result := strings.Join(resultLines, "\n")
+ return totalLines, int64(len(result)), nil
+ })
+ require.NoError(t, err2)
+
+ assert.Greater(t, profile2.MemoryDelta, profile1.MemoryDelta,
+ "Sliding window should use less memory than reading all into memory")
+
+ assert.Equal(t, profile1.LinesCount, profile2.LinesCount,
+ "Both approaches should count the same number of input lines")
+ assert.InDelta(t, profile1.BytesCount, profile2.BytesCount, 100,
+ "Both approaches should produce similar output sizes (within 100 bytes)")
+
+ memoryReduction := float64(profile2.MemoryDelta-profile1.MemoryDelta) / float64(profile2.MemoryDelta) * 100
+ t.Logf("Memory reduction: %.1f%% (%.2f MB vs %.2f MB)",
+ memoryReduction,
+ float64(profile2.MemoryDelta)/1024/1024,
+ float64(profile1.MemoryDelta)/1024/1024)
+
+ t.Logf("Baseline: %d bytes", baselineStats.Alloc)
+ t.Logf("Sliding window: %s", profile1.String())
+ t.Logf("No window: %s", profile2.String())
+}
diff --git a/pkg/github/context_tools.go b/pkg/github/context_tools.go
index 9817fea7b..06642aa15 100644
--- a/pkg/github/context_tools.go
+++ b/pkg/github/context_tools.go
@@ -8,6 +8,7 @@ import (
"github.com/github/github-mcp-server/pkg/translations"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
+ "github.com/shurcooL/githubv4"
)
// UserDetails contains additional fields about a GitHub user not already
@@ -90,3 +91,161 @@ func GetMe(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Too
return tool, handler
}
+
+type TeamInfo struct {
+ Name string `json:"name"`
+ Slug string `json:"slug"`
+ Description string `json:"description"`
+}
+
+type OrganizationTeams struct {
+ Org string `json:"org"`
+ Teams []TeamInfo `json:"teams"`
+}
+
+func GetTeams(getClient GetClientFn, getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
+ return mcp.NewTool("get_teams",
+ mcp.WithDescription(t("TOOL_GET_TEAMS_DESCRIPTION", "Get details of the teams the user is a member of. Limited to organizations accessible with current credentials")),
+ mcp.WithString("user",
+ mcp.Description(t("TOOL_GET_TEAMS_USER_DESCRIPTION", "Username to get teams for. If not provided, uses the authenticated user.")),
+ ),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_GET_TEAMS_TITLE", "Get teams"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ user, err := OptionalParam[string](request, "user")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ var username string
+ if user != "" {
+ username = user
+ } else {
+ client, err := getClient(ctx)
+ if err != nil {
+ return mcp.NewToolResultErrorFromErr("failed to get GitHub client", err), nil
+ }
+
+ userResp, res, err := client.Users.Get(ctx, "")
+ if err != nil {
+ return ghErrors.NewGitHubAPIErrorResponse(ctx,
+ "failed to get user",
+ res,
+ err,
+ ), nil
+ }
+ username = userResp.GetLogin()
+ }
+
+ gqlClient, err := getGQLClient(ctx)
+ if err != nil {
+ return mcp.NewToolResultErrorFromErr("failed to get GitHub GQL client", err), nil
+ }
+
+ var q struct {
+ User struct {
+ Organizations struct {
+ Nodes []struct {
+ Login githubv4.String
+ Teams struct {
+ Nodes []struct {
+ Name githubv4.String
+ Slug githubv4.String
+ Description githubv4.String
+ }
+ } `graphql:"teams(first: 100, userLogins: [$login])"`
+ }
+ } `graphql:"organizations(first: 100)"`
+ } `graphql:"user(login: $login)"`
+ }
+ vars := map[string]interface{}{
+ "login": githubv4.String(username),
+ }
+ if err := gqlClient.Query(ctx, &q, vars); err != nil {
+ return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "Failed to find teams", err), nil
+ }
+
+ var organizations []OrganizationTeams
+ for _, org := range q.User.Organizations.Nodes {
+ orgTeams := OrganizationTeams{
+ Org: string(org.Login),
+ Teams: make([]TeamInfo, 0, len(org.Teams.Nodes)),
+ }
+
+ for _, team := range org.Teams.Nodes {
+ orgTeams.Teams = append(orgTeams.Teams, TeamInfo{
+ Name: string(team.Name),
+ Slug: string(team.Slug),
+ Description: string(team.Description),
+ })
+ }
+
+ organizations = append(organizations, orgTeams)
+ }
+
+ return MarshalledTextResult(organizations), nil
+ }
+}
+
+func GetTeamMembers(getGQLClient GetGQLClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
+ return mcp.NewTool("get_team_members",
+ mcp.WithDescription(t("TOOL_GET_TEAM_MEMBERS_DESCRIPTION", "Get member usernames of a specific team in an organization. Limited to organizations accessible with current credentials")),
+ mcp.WithString("org",
+ mcp.Description(t("TOOL_GET_TEAM_MEMBERS_ORG_DESCRIPTION", "Organization login (owner) that contains the team.")),
+ mcp.Required(),
+ ),
+ mcp.WithString("team_slug",
+ mcp.Description(t("TOOL_GET_TEAM_MEMBERS_TEAM_SLUG_DESCRIPTION", "Team slug")),
+ mcp.Required(),
+ ),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_GET_TEAM_MEMBERS_TITLE", "Get team members"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ org, err := RequiredParam[string](request, "org")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ teamSlug, err := RequiredParam[string](request, "team_slug")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ gqlClient, err := getGQLClient(ctx)
+ if err != nil {
+ return mcp.NewToolResultErrorFromErr("failed to get GitHub GQL client", err), nil
+ }
+
+ var q struct {
+ Organization struct {
+ Team struct {
+ Members struct {
+ Nodes []struct {
+ Login githubv4.String
+ }
+ } `graphql:"members(first: 100)"`
+ } `graphql:"team(slug: $teamSlug)"`
+ } `graphql:"organization(login: $org)"`
+ }
+ vars := map[string]interface{}{
+ "org": githubv4.String(org),
+ "teamSlug": githubv4.String(teamSlug),
+ }
+ if err := gqlClient.Query(ctx, &q, vars); err != nil {
+ return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "Failed to get team members", err), nil
+ }
+
+ var members []string
+ for _, member := range q.Organization.Team.Members.Nodes {
+ members = append(members, string(member.Login))
+ }
+
+ return MarshalledTextResult(members), nil
+ }
+}
diff --git a/pkg/github/context_tools_test.go b/pkg/github/context_tools_test.go
index ca33f8493..641707a47 100644
--- a/pkg/github/context_tools_test.go
+++ b/pkg/github/context_tools_test.go
@@ -3,13 +3,16 @@ package github
import (
"context"
"encoding/json"
+ "fmt"
"testing"
"time"
+ "github.com/github/github-mcp-server/internal/githubv4mock"
"github.com/github/github-mcp-server/internal/toolsnaps"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v74/github"
"github.com/migueleliasweb/go-github-mock/src/mock"
+ "github.com/shurcooL/githubv4"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -139,3 +142,358 @@ func Test_GetMe(t *testing.T) {
})
}
}
+
+func Test_GetTeams(t *testing.T) {
+ t.Parallel()
+
+ tool, _ := GetTeams(nil, nil, translations.NullTranslationHelper)
+ require.NoError(t, toolsnaps.Test(tool.Name, tool))
+
+ assert.Equal(t, "get_teams", tool.Name)
+ assert.True(t, *tool.Annotations.ReadOnlyHint, "get_teams tool should be read-only")
+
+ mockUser := &github.User{
+ Login: github.Ptr("testuser"),
+ Name: github.Ptr("Test User"),
+ Email: github.Ptr("test@example.com"),
+ Bio: github.Ptr("GitHub user for testing"),
+ Company: github.Ptr("Test Company"),
+ Location: github.Ptr("Test Location"),
+ HTMLURL: github.Ptr("https://github.com/testuser"),
+ CreatedAt: &github.Timestamp{Time: time.Now().Add(-365 * 24 * time.Hour)},
+ Type: github.Ptr("User"),
+ Hireable: github.Ptr(true),
+ TwitterUsername: github.Ptr("testuser_twitter"),
+ Plan: &github.Plan{
+ Name: github.Ptr("pro"),
+ },
+ }
+
+ mockTeamsResponse := githubv4mock.DataResponse(map[string]any{
+ "user": map[string]any{
+ "organizations": map[string]any{
+ "nodes": []map[string]any{
+ {
+ "login": "testorg1",
+ "teams": map[string]any{
+ "nodes": []map[string]any{
+ {
+ "name": "team1",
+ "slug": "team1",
+ "description": "Team 1",
+ },
+ {
+ "name": "team2",
+ "slug": "team2",
+ "description": "Team 2",
+ },
+ },
+ },
+ },
+ {
+ "login": "testorg2",
+ "teams": map[string]any{
+ "nodes": []map[string]any{
+ {
+ "name": "team3",
+ "slug": "team3",
+ "description": "Team 3",
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+ })
+
+ mockNoTeamsResponse := githubv4mock.DataResponse(map[string]any{
+ "user": map[string]any{
+ "organizations": map[string]any{
+ "nodes": []map[string]any{},
+ },
+ },
+ })
+
+ tests := []struct {
+ name string
+ stubbedGetClientFn GetClientFn
+ stubbedGetGQLClientFn GetGQLClientFn
+ requestArgs map[string]any
+ expectToolError bool
+ expectedToolErrMsg string
+ expectedTeamsCount int
+ }{
+ {
+ name: "successful get teams",
+ stubbedGetClientFn: stubGetClientFromHTTPFn(
+ mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetUser,
+ mockUser,
+ ),
+ ),
+ ),
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
+ vars := map[string]interface{}{
+ "login": "testuser",
+ }
+ matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamsResponse)
+ httpClient := githubv4mock.NewMockedHTTPClient(matcher)
+ return githubv4.NewClient(httpClient), nil
+ },
+ requestArgs: map[string]any{},
+ expectToolError: false,
+ expectedTeamsCount: 2,
+ },
+ {
+ name: "successful get teams for specific user",
+ stubbedGetClientFn: nil,
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
+ vars := map[string]interface{}{
+ "login": "specificuser",
+ }
+ matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamsResponse)
+ httpClient := githubv4mock.NewMockedHTTPClient(matcher)
+ return githubv4.NewClient(httpClient), nil
+ },
+ requestArgs: map[string]any{
+ "user": "specificuser",
+ },
+ expectToolError: false,
+ expectedTeamsCount: 2,
+ },
+ {
+ name: "no teams found",
+ stubbedGetClientFn: stubGetClientFromHTTPFn(
+ mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetUser,
+ mockUser,
+ ),
+ ),
+ ),
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ queryStr := "query($login:String!){user(login: $login){organizations(first: 100){nodes{login,teams(first: 100, userLogins: [$login]){nodes{name,slug,description}}}}}}"
+ vars := map[string]interface{}{
+ "login": "testuser",
+ }
+ matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockNoTeamsResponse)
+ httpClient := githubv4mock.NewMockedHTTPClient(matcher)
+ return githubv4.NewClient(httpClient), nil
+ },
+ requestArgs: map[string]any{},
+ expectToolError: false,
+ expectedTeamsCount: 0,
+ },
+ {
+ name: "getting client fails",
+ stubbedGetClientFn: stubGetClientFnErr("expected test error"),
+ stubbedGetGQLClientFn: nil,
+ requestArgs: map[string]any{},
+ expectToolError: true,
+ expectedToolErrMsg: "failed to get GitHub client: expected test error",
+ },
+ {
+ name: "get user fails",
+ stubbedGetClientFn: stubGetClientFromHTTPFn(
+ mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetUser,
+ badRequestHandler("expected test failure"),
+ ),
+ ),
+ ),
+ stubbedGetGQLClientFn: nil,
+ requestArgs: map[string]any{},
+ expectToolError: true,
+ expectedToolErrMsg: "expected test failure",
+ },
+ {
+ name: "getting GraphQL client fails",
+ stubbedGetClientFn: stubGetClientFromHTTPFn(
+ mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetUser,
+ mockUser,
+ ),
+ ),
+ ),
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ return nil, fmt.Errorf("GraphQL client error")
+ },
+ requestArgs: map[string]any{},
+ expectToolError: true,
+ expectedToolErrMsg: "failed to get GitHub GQL client: GraphQL client error",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ _, handler := GetTeams(tc.stubbedGetClientFn, tc.stubbedGetGQLClientFn, translations.NullTranslationHelper)
+
+ request := createMCPRequest(tc.requestArgs)
+ result, err := handler(context.Background(), request)
+ require.NoError(t, err)
+ textContent := getTextResult(t, result)
+
+ if tc.expectToolError {
+ assert.True(t, result.IsError, "expected tool call result to be an error")
+ assert.Contains(t, textContent.Text, tc.expectedToolErrMsg)
+ return
+ }
+
+ var organizations []OrganizationTeams
+ err = json.Unmarshal([]byte(textContent.Text), &organizations)
+ require.NoError(t, err)
+
+ assert.Len(t, organizations, tc.expectedTeamsCount)
+
+ if tc.expectedTeamsCount > 0 {
+ assert.Equal(t, "testorg1", organizations[0].Org)
+ assert.Len(t, organizations[0].Teams, 2)
+ assert.Equal(t, "team1", organizations[0].Teams[0].Name)
+ assert.Equal(t, "team1", organizations[0].Teams[0].Slug)
+ assert.Equal(t, "Team 1", organizations[0].Teams[0].Description)
+
+ if tc.expectedTeamsCount > 1 {
+ assert.Equal(t, "testorg2", organizations[1].Org)
+ assert.Len(t, organizations[1].Teams, 1)
+ assert.Equal(t, "team3", organizations[1].Teams[0].Name)
+ assert.Equal(t, "team3", organizations[1].Teams[0].Slug)
+ assert.Equal(t, "Team 3", organizations[1].Teams[0].Description)
+ }
+ }
+ })
+ }
+}
+
+func Test_GetTeamMembers(t *testing.T) {
+ t.Parallel()
+
+ tool, _ := GetTeamMembers(nil, translations.NullTranslationHelper)
+ require.NoError(t, toolsnaps.Test(tool.Name, tool))
+
+ assert.Equal(t, "get_team_members", tool.Name)
+ assert.True(t, *tool.Annotations.ReadOnlyHint, "get_team_members tool should be read-only")
+
+ mockTeamMembersResponse := githubv4mock.DataResponse(map[string]any{
+ "organization": map[string]any{
+ "team": map[string]any{
+ "members": map[string]any{
+ "nodes": []map[string]any{
+ {
+ "login": "user1",
+ },
+ {
+ "login": "user2",
+ },
+ },
+ },
+ },
+ },
+ })
+
+ mockNoMembersResponse := githubv4mock.DataResponse(map[string]any{
+ "organization": map[string]any{
+ "team": map[string]any{
+ "members": map[string]any{
+ "nodes": []map[string]any{},
+ },
+ },
+ },
+ })
+
+ tests := []struct {
+ name string
+ stubbedGetGQLClientFn GetGQLClientFn
+ requestArgs map[string]any
+ expectToolError bool
+ expectedToolErrMsg string
+ expectedMembersCount int
+ }{
+ {
+ name: "successful get team members",
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ queryStr := "query($org:String!$teamSlug:String!){organization(login: $org){team(slug: $teamSlug){members(first: 100){nodes{login}}}}}"
+ vars := map[string]interface{}{
+ "org": "testorg",
+ "teamSlug": "testteam",
+ }
+ matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockTeamMembersResponse)
+ httpClient := githubv4mock.NewMockedHTTPClient(matcher)
+ return githubv4.NewClient(httpClient), nil
+ },
+ requestArgs: map[string]any{
+ "org": "testorg",
+ "team_slug": "testteam",
+ },
+ expectToolError: false,
+ expectedMembersCount: 2,
+ },
+ {
+ name: "team with no members",
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ queryStr := "query($org:String!$teamSlug:String!){organization(login: $org){team(slug: $teamSlug){members(first: 100){nodes{login}}}}}"
+ vars := map[string]interface{}{
+ "org": "testorg",
+ "teamSlug": "emptyteam",
+ }
+ matcher := githubv4mock.NewQueryMatcher(queryStr, vars, mockNoMembersResponse)
+ httpClient := githubv4mock.NewMockedHTTPClient(matcher)
+ return githubv4.NewClient(httpClient), nil
+ },
+ requestArgs: map[string]any{
+ "org": "testorg",
+ "team_slug": "emptyteam",
+ },
+ expectToolError: false,
+ expectedMembersCount: 0,
+ },
+ {
+ name: "getting GraphQL client fails",
+ stubbedGetGQLClientFn: func(_ context.Context) (*githubv4.Client, error) {
+ return nil, fmt.Errorf("GraphQL client error")
+ },
+ requestArgs: map[string]any{
+ "org": "testorg",
+ "team_slug": "testteam",
+ },
+ expectToolError: true,
+ expectedToolErrMsg: "failed to get GitHub GQL client: GraphQL client error",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ _, handler := GetTeamMembers(tc.stubbedGetGQLClientFn, translations.NullTranslationHelper)
+
+ request := createMCPRequest(tc.requestArgs)
+ result, err := handler(context.Background(), request)
+ require.NoError(t, err)
+ textContent := getTextResult(t, result)
+
+ if tc.expectToolError {
+ assert.True(t, result.IsError, "expected tool call result to be an error")
+ assert.Contains(t, textContent.Text, tc.expectedToolErrMsg)
+ return
+ }
+
+ var members []string
+ err = json.Unmarshal([]byte(textContent.Text), &members)
+ require.NoError(t, err)
+
+ assert.Len(t, members, tc.expectedMembersCount)
+
+ if tc.expectedMembersCount > 0 {
+ assert.Equal(t, "user1", members[0])
+
+ if tc.expectedMembersCount > 1 {
+ assert.Equal(t, "user2", members[1])
+ }
+ }
+ })
+ }
+}
diff --git a/pkg/github/issues.go b/pkg/github/issues.go
index ad0a0749b..89375ae90 100644
--- a/pkg/github/issues.go
+++ b/pkg/github/issues.go
@@ -38,6 +38,9 @@ type IssueFragment struct {
Description githubv4.String
}
} `graphql:"labels(first: 100)"`
+ Comments struct {
+ TotalCount githubv4.Int
+ } `graphql:"comments"`
}
// Common interface for all issue query types
@@ -133,10 +136,11 @@ func fragmentToIssue(fragment IssueFragment) *github.Issue {
User: &github.User{
Login: github.Ptr(string(fragment.Author.Login)),
},
- State: github.Ptr(string(fragment.State)),
- ID: github.Ptr(fragment.DatabaseID),
- Body: github.Ptr(string(fragment.Body)),
- Labels: foundLabels,
+ State: github.Ptr(string(fragment.State)),
+ ID: github.Ptr(fragment.DatabaseID),
+ Body: github.Ptr(string(fragment.Body)),
+ Labels: foundLabels,
+ Comments: github.Ptr(int(fragment.Comments.TotalCount)),
}
}
@@ -202,6 +206,53 @@ func GetIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool
}
}
+// ListIssueTypes creates a tool to list defined issue types for an organization. This can be used to understand supported issue type values for creating or updating issues.
+func ListIssueTypes(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+
+ return mcp.NewTool("list_issue_types",
+ mcp.WithDescription(t("TOOL_LIST_ISSUE_TYPES_FOR_ORG", "List supported issue types for repository owner (organization).")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_LIST_ISSUE_TYPES_USER_TITLE", "List available issue types"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("owner",
+ mcp.Required(),
+ mcp.Description("The organization owner of the repository"),
+ ),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ owner, err := RequiredParam[string](request, "owner")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+ issueTypes, resp, err := client.Organizations.ListIssueTypes(ctx, owner)
+ if err != nil {
+ return nil, fmt.Errorf("failed to list issue types: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to list issue types: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(issueTypes)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal issue types: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
// AddIssueComment creates a tool to add a comment to an issue.
func AddIssueComment(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("add_issue_comment",
@@ -506,57 +557,29 @@ func RemoveSubIssue(getClient GetClientFn, t translations.TranslationHelperFunc)
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
- // Create the request body
- requestBody := map[string]interface{}{
- "sub_issue_id": subIssueID,
- }
- reqBodyBytes, err := json.Marshal(requestBody)
- if err != nil {
- return nil, fmt.Errorf("failed to marshal request body: %w", err)
- }
-
- // Create the HTTP request
- url := fmt.Sprintf("%srepos/%s/%s/issues/%d/sub_issue",
- client.BaseURL.String(), owner, repo, issueNumber)
- req, err := http.NewRequestWithContext(ctx, "DELETE", url, strings.NewReader(string(reqBodyBytes)))
- if err != nil {
- return nil, fmt.Errorf("failed to create request: %w", err)
+ subIssueRequest := github.SubIssueRequest{
+ SubIssueID: int64(subIssueID),
}
- req.Header.Set("Accept", "application/vnd.github+json")
- req.Header.Set("Content-Type", "application/json")
- req.Header.Set("X-GitHub-Api-Version", "2022-11-28")
- httpClient := client.Client() // Use authenticated GitHub client
- resp, err := httpClient.Do(req)
+ subIssue, resp, err := client.SubIssue.Remove(ctx, owner, repo, int64(issueNumber), subIssueRequest)
if err != nil {
- var ghResp *github.Response
- if resp != nil {
- ghResp = &github.Response{Response: resp}
- }
return ghErrors.NewGitHubAPIErrorResponse(ctx,
"failed to remove sub-issue",
- ghResp,
+ resp,
err,
), nil
}
defer func() { _ = resp.Body.Close() }()
- body, err := io.ReadAll(resp.Body)
- if err != nil {
- return nil, fmt.Errorf("failed to read response body: %w", err)
- }
-
if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
return mcp.NewToolResultError(fmt.Sprintf("failed to remove sub-issue: %s", string(body))), nil
}
- // Parse and re-marshal to ensure consistent formatting
- var result interface{}
- if err := json.Unmarshal(body, &result); err != nil {
- return nil, fmt.Errorf("failed to unmarshal response: %w", err)
- }
-
- r, err := json.Marshal(result)
+ r, err := json.Marshal(subIssue)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -765,6 +788,9 @@ func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
mcp.WithNumber("milestone",
mcp.Description("Milestone number"),
),
+ mcp.WithString("type",
+ mcp.Description("Type of this issue"),
+ ),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
owner, err := RequiredParam[string](request, "owner")
@@ -809,6 +835,12 @@ func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
milestoneNum = &milestone
}
+ // Get optional type
+ issueType, err := OptionalParam[string](request, "type")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
// Create the issue request
issueRequest := &github.IssueRequest{
Title: github.Ptr(title),
@@ -818,6 +850,10 @@ func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
Milestone: milestoneNum,
}
+ if issueType != "" {
+ issueRequest.Type = github.Ptr(issueType)
+ }
+
client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
@@ -875,7 +911,7 @@ func ListIssues(getGQLClient GetGQLClientFn, t translations.TranslationHelperFun
),
mcp.WithString("orderBy",
mcp.Description("Order issues by field. If provided, the 'direction' also needs to be provided."),
- mcp.Enum("CREATED_AT", "UPDATED_AT"),
+ mcp.Enum("CREATED_AT", "UPDATED_AT", "COMMENTS"),
),
mcp.WithString("direction",
mcp.Description("Order direction. If provided, the 'orderBy' also needs to be provided."),
@@ -1106,6 +1142,9 @@ func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
mcp.WithNumber("milestone",
mcp.Description("New milestone number"),
),
+ mcp.WithString("type",
+ mcp.Description("New issue type"),
+ ),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
owner, err := RequiredParam[string](request, "owner")
@@ -1176,6 +1215,15 @@ func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
issueRequest.Milestone = &milestoneNum
}
+ // Get issue type
+ issueType, err := OptionalParam[string](request, "type")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ if issueType != "" {
+ issueRequest.Type = github.Ptr(issueType)
+ }
+
client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
@@ -1504,7 +1552,7 @@ func AssignCodingAgentPrompt(t translations.TranslationHelperFunc) (tool mcp.Pro
messages := []mcp.PromptMessage{
{
- Role: "system",
+ Role: "user",
Content: mcp.NewTextContent("You are a personal assistant for GitHub the Copilot GitHub Coding Agent. Your task is to help the user assign tasks to the Coding Agent based on their open GitHub issues. You can use `assign_copilot_to_issue` tool to assign the Coding Agent to issues that are suitable for autonomous work, and `search_issues` tool to find issues that match the user's criteria. You can also use `list_issues` to get a list of issues in the repository."),
},
{
diff --git a/pkg/github/issues_test.go b/pkg/github/issues_test.go
index 2a530ef48..7c4983c64 100644
--- a/pkg/github/issues_test.go
+++ b/pkg/github/issues_test.go
@@ -5,6 +5,7 @@ import (
"encoding/json"
"fmt"
"net/http"
+ "strings"
"testing"
"time"
@@ -410,6 +411,100 @@ func Test_SearchIssues(t *testing.T) {
expectError: false,
expectedResult: mockSearchResult,
},
+ {
+ name: "query with existing is:issue filter - no duplication",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "repo:github/github-mcp-server is:issue is:open (label:critical OR label:urgent)",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "repo:github/github-mcp-server is:issue is:open (label:critical OR label:urgent)",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "query with existing repo: filter and conflicting owner/repo params - uses query filter",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "is:issue repo:github/github-mcp-server critical",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "repo:github/github-mcp-server critical",
+ "owner": "different-owner",
+ "repo": "different-repo",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "query with both is: and repo: filters already present",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "is:issue repo:octocat/Hello-World bug",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "is:issue repo:octocat/Hello-World bug",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "complex query with multiple OR operators and existing filters",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "repo:github/github-mcp-server is:issue (label:critical OR label:urgent OR label:high-priority OR label:blocker)",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "repo:github/github-mcp-server is:issue (label:critical OR label:urgent OR label:high-priority OR label:blocker)",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
{
name: "search issues fails",
mockedClient: mock.NewMockedHTTPClient(
@@ -486,6 +581,7 @@ func Test_CreateIssue(t *testing.T) {
assert.Contains(t, tool.InputSchema.Properties, "assignees")
assert.Contains(t, tool.InputSchema.Properties, "labels")
assert.Contains(t, tool.InputSchema.Properties, "milestone")
+ assert.Contains(t, tool.InputSchema.Properties, "type")
assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo", "title"})
// Setup mock issue for success case
@@ -498,6 +594,7 @@ func Test_CreateIssue(t *testing.T) {
Assignees: []*github.User{{Login: github.Ptr("user1")}, {Login: github.Ptr("user2")}},
Labels: []*github.Label{{Name: github.Ptr("bug")}, {Name: github.Ptr("help wanted")}},
Milestone: &github.Milestone{Number: github.Ptr(5)},
+ Type: &github.IssueType{Name: github.Ptr("Bug")},
}
tests := []struct {
@@ -519,6 +616,7 @@ func Test_CreateIssue(t *testing.T) {
"labels": []any{"bug", "help wanted"},
"assignees": []any{"user1", "user2"},
"milestone": float64(5),
+ "type": "Bug",
}).andThen(
mockResponse(t, http.StatusCreated, mockIssue),
),
@@ -532,6 +630,7 @@ func Test_CreateIssue(t *testing.T) {
"assignees": []any{"user1", "user2"},
"labels": []any{"bug", "help wanted"},
"milestone": float64(5),
+ "type": "Bug",
},
expectError: false,
expectedIssue: mockIssue,
@@ -627,6 +726,10 @@ func Test_CreateIssue(t *testing.T) {
assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
}
+ if tc.expectedIssue.Type != nil {
+ assert.Equal(t, *tc.expectedIssue.Type.Name, *returnedIssue.Type.Name)
+ }
+
// Check assignees if expected
if len(tc.expectedIssue.Assignees) > 0 {
assert.Equal(t, len(tc.expectedIssue.Assignees), len(returnedIssue.Assignees))
@@ -681,6 +784,9 @@ func Test_ListIssues(t *testing.T) {
{"name": "bug", "id": "label1", "description": "Bug label"},
},
},
+ "comments": map[string]any{
+ "totalCount": 5,
+ },
},
{
"number": 456,
@@ -696,6 +802,9 @@ func Test_ListIssues(t *testing.T) {
{"name": "enhancement", "id": "label2", "description": "Enhancement label"},
},
},
+ "comments": map[string]any{
+ "totalCount": 3,
+ },
},
}
@@ -713,6 +822,9 @@ func Test_ListIssues(t *testing.T) {
"labels": map[string]any{
"nodes": []map[string]any{},
},
+ "comments": map[string]any{
+ "totalCount": 1,
+ },
},
}
@@ -875,8 +987,8 @@ func Test_ListIssues(t *testing.T) {
}
// Define the actual query strings that match the implementation
- qBasicNoLabels := "query($after:String$direction:OrderDirection!$first:Int!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, states: $states, orderBy: {field: $orderBy, direction: $direction}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount}}}"
- qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, states: $states, orderBy: {field: $orderBy, direction: $direction}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount}}}"
+ qBasicNoLabels := "query($after:String$direction:OrderDirection!$first:Int!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, states: $states, orderBy: {field: $orderBy, direction: $direction}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount}}}"
+ qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, states: $states, orderBy: {field: $orderBy, direction: $direction}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount}}}"
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
@@ -962,6 +1074,7 @@ func Test_UpdateIssue(t *testing.T) {
assert.Contains(t, tool.InputSchema.Properties, "labels")
assert.Contains(t, tool.InputSchema.Properties, "assignees")
assert.Contains(t, tool.InputSchema.Properties, "milestone")
+ assert.Contains(t, tool.InputSchema.Properties, "type")
assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo", "issue_number"})
// Setup mock issue for success case
@@ -974,6 +1087,7 @@ func Test_UpdateIssue(t *testing.T) {
Assignees: []*github.User{{Login: github.Ptr("assignee1")}, {Login: github.Ptr("assignee2")}},
Labels: []*github.Label{{Name: github.Ptr("bug")}, {Name: github.Ptr("priority")}},
Milestone: &github.Milestone{Number: github.Ptr(5)},
+ Type: &github.IssueType{Name: github.Ptr("Bug")},
}
tests := []struct {
@@ -996,6 +1110,7 @@ func Test_UpdateIssue(t *testing.T) {
"labels": []any{"bug", "priority"},
"assignees": []any{"assignee1", "assignee2"},
"milestone": float64(5),
+ "type": "Bug",
}).andThen(
mockResponse(t, http.StatusOK, mockIssue),
),
@@ -1011,6 +1126,7 @@ func Test_UpdateIssue(t *testing.T) {
"labels": []any{"bug", "priority"},
"assignees": []any{"assignee1", "assignee2"},
"milestone": float64(5),
+ "type": "Bug",
},
expectError: false,
expectedIssue: mockIssue,
@@ -1022,9 +1138,10 @@ func Test_UpdateIssue(t *testing.T) {
mock.PatchReposIssuesByOwnerByRepoByIssueNumber,
mockResponse(t, http.StatusOK, &github.Issue{
Number: github.Ptr(123),
- Title: github.Ptr("Only Title Updated"),
+ Title: github.Ptr("Updated Issue Title"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/123"),
State: github.Ptr("open"),
+ Type: &github.IssueType{Name: github.Ptr("Feature")},
}),
),
),
@@ -1032,14 +1149,16 @@ func Test_UpdateIssue(t *testing.T) {
"owner": "owner",
"repo": "repo",
"issue_number": float64(123),
- "title": "Only Title Updated",
+ "title": "Updated Issue Title",
+ "type": "Feature",
},
expectError: false,
expectedIssue: &github.Issue{
Number: github.Ptr(123),
- Title: github.Ptr("Only Title Updated"),
+ Title: github.Ptr("Updated Issue Title"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/123"),
State: github.Ptr("open"),
+ Type: &github.IssueType{Name: github.Ptr("Feature")},
},
},
{
@@ -1128,6 +1247,10 @@ func Test_UpdateIssue(t *testing.T) {
assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
}
+ if tc.expectedIssue.Type != nil {
+ assert.Equal(t, *tc.expectedIssue.Type.Name, *returnedIssue.Type.Name)
+ }
+
// Check assignees if expected
if len(tc.expectedIssue.Assignees) > 0 {
assert.Len(t, returnedIssue.Assignees, len(tc.expectedIssue.Assignees))
@@ -2723,3 +2846,146 @@ func Test_ReprioritizeSubIssue(t *testing.T) {
})
}
}
+
+func Test_ListIssueTypes(t *testing.T) {
+ // Verify tool definition once
+ mockClient := github.NewClient(nil)
+ tool, _ := ListIssueTypes(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+ require.NoError(t, toolsnaps.Test(tool.Name, tool))
+
+ assert.Equal(t, "list_issue_types", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "owner")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner"})
+
+ // Setup mock issue types for success case
+ mockIssueTypes := []*github.IssueType{
+ {
+ ID: github.Ptr(int64(1)),
+ Name: github.Ptr("bug"),
+ Description: github.Ptr("Something isn't working"),
+ Color: github.Ptr("d73a4a"),
+ },
+ {
+ ID: github.Ptr(int64(2)),
+ Name: github.Ptr("feature"),
+ Description: github.Ptr("New feature or enhancement"),
+ Color: github.Ptr("a2eeef"),
+ },
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedIssueTypes []*github.IssueType
+ expectedErrMsg string
+ }{
+ {
+ name: "successful issue types retrieval",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.EndpointPattern{
+ Pattern: "/orgs/testorg/issue-types",
+ Method: "GET",
+ },
+ mockResponse(t, http.StatusOK, mockIssueTypes),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "testorg",
+ },
+ expectError: false,
+ expectedIssueTypes: mockIssueTypes,
+ },
+ {
+ name: "organization not found",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.EndpointPattern{
+ Pattern: "/orgs/nonexistent/issue-types",
+ Method: "GET",
+ },
+ mockResponse(t, http.StatusNotFound, `{"message": "Organization not found"}`),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "nonexistent",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to list issue types",
+ },
+ {
+ name: "missing owner parameter",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.EndpointPattern{
+ Pattern: "/orgs/testorg/issue-types",
+ Method: "GET",
+ },
+ mockResponse(t, http.StatusOK, mockIssueTypes),
+ ),
+ ),
+ requestArgs: map[string]interface{}{},
+ expectError: false, // This should be handled by parameter validation, error returned in result
+ expectedErrMsg: "missing required parameter: owner",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ // Setup client with mock
+ client := github.NewClient(tc.mockedClient)
+ _, handler := ListIssueTypes(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ // Create call request
+ request := createMCPRequest(tc.requestArgs)
+
+ // Call handler
+ result, err := handler(context.Background(), request)
+
+ // Verify results
+ if tc.expectError {
+ if err != nil {
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+ // Check if error is returned as tool result error
+ require.NotNil(t, result)
+ require.True(t, result.IsError)
+ errorContent := getErrorResult(t, result)
+ assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
+ return
+ }
+
+ // Check if it's a parameter validation error (returned as tool result error)
+ if result != nil && result.IsError {
+ errorContent := getErrorResult(t, result)
+ if tc.expectedErrMsg != "" && strings.Contains(errorContent.Text, tc.expectedErrMsg) {
+ return // This is expected for parameter validation errors
+ }
+ }
+
+ require.NoError(t, err)
+ require.NotNil(t, result)
+ require.False(t, result.IsError)
+ textContent := getTextResult(t, result)
+
+ // Unmarshal and verify the result
+ var returnedIssueTypes []*github.IssueType
+ err = json.Unmarshal([]byte(textContent.Text), &returnedIssueTypes)
+ require.NoError(t, err)
+
+ if tc.expectedIssueTypes != nil {
+ require.Equal(t, len(tc.expectedIssueTypes), len(returnedIssueTypes))
+ for i, expected := range tc.expectedIssueTypes {
+ assert.Equal(t, *expected.Name, *returnedIssueTypes[i].Name)
+ assert.Equal(t, *expected.Description, *returnedIssueTypes[i].Description)
+ assert.Equal(t, *expected.Color, *returnedIssueTypes[i].Color)
+ assert.Equal(t, *expected.ID, *returnedIssueTypes[i].ID)
+ }
+ }
+ })
+ }
+}
diff --git a/pkg/github/pullrequests_test.go b/pkg/github/pullrequests_test.go
index f759885ee..ed6921477 100644
--- a/pkg/github/pullrequests_test.go
+++ b/pkg/github/pullrequests_test.go
@@ -1030,6 +1030,77 @@ func Test_SearchPullRequests(t *testing.T) {
expectError: false,
expectedResult: mockSearchResult,
},
+ {
+ name: "query with existing is:pr filter - no duplication",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "is:pr repo:github/github-mcp-server is:open draft:false",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "is:pr repo:github/github-mcp-server is:open draft:false",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "query with existing repo: filter and conflicting owner/repo params - uses query filter",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "is:pr repo:github/github-mcp-server author:octocat",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "repo:github/github-mcp-server author:octocat",
+ "owner": "different-owner",
+ "repo": "different-repo",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "complex query with existing is:pr filter and OR operators",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchIssues,
+ expectQueryParams(
+ t,
+ map[string]string{
+ "q": "is:pr repo:github/github-mcp-server (label:bug OR label:enhancement OR label:feature)",
+ "page": "1",
+ "per_page": "30",
+ },
+ ).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "is:pr repo:github/github-mcp-server (label:bug OR label:enhancement OR label:feature)",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
{
name: "search pull requests fails",
mockedClient: mock.NewMockedHTTPClient(
diff --git a/pkg/github/repositories.go b/pkg/github/repositories.go
index 5cb7769b0..de2c6d01f 100644
--- a/pkg/github/repositories.go
+++ b/pkg/github/repositories.go
@@ -1321,6 +1321,192 @@ func GetTag(getClient GetClientFn, t translations.TranslationHelperFunc) (tool m
}
}
+// ListReleases creates a tool to list releases in a GitHub repository.
+func ListReleases(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("list_releases",
+ mcp.WithDescription(t("TOOL_LIST_RELEASES_DESCRIPTION", "List releases in a GitHub repository")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_LIST_RELEASES_USER_TITLE", "List releases"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("owner",
+ mcp.Required(),
+ mcp.Description("Repository owner"),
+ ),
+ mcp.WithString("repo",
+ mcp.Required(),
+ mcp.Description("Repository name"),
+ ),
+ WithPagination(),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ owner, err := RequiredParam[string](request, "owner")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ repo, err := RequiredParam[string](request, "repo")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ pagination, err := OptionalPaginationParams(request)
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ opts := &github.ListOptions{
+ Page: pagination.Page,
+ PerPage: pagination.PerPage,
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ releases, resp, err := client.Repositories.ListReleases(ctx, owner, repo, opts)
+ if err != nil {
+ return nil, fmt.Errorf("failed to list releases: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to list releases: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(releases)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal response: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
+// GetLatestRelease creates a tool to get the latest release in a GitHub repository.
+func GetLatestRelease(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("get_latest_release",
+ mcp.WithDescription(t("TOOL_GET_LATEST_RELEASE_DESCRIPTION", "Get the latest release in a GitHub repository")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_GET_LATEST_RELEASE_USER_TITLE", "Get latest release"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("owner",
+ mcp.Required(),
+ mcp.Description("Repository owner"),
+ ),
+ mcp.WithString("repo",
+ mcp.Required(),
+ mcp.Description("Repository name"),
+ ),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ owner, err := RequiredParam[string](request, "owner")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ repo, err := RequiredParam[string](request, "repo")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ release, resp, err := client.Repositories.GetLatestRelease(ctx, owner, repo)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get latest release: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to get latest release: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(release)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal response: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
+func GetReleaseByTag(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("get_release_by_tag",
+ mcp.WithDescription(t("TOOL_GET_RELEASE_BY_TAG_DESCRIPTION", "Get a specific release by its tag name in a GitHub repository")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_GET_RELEASE_BY_TAG_USER_TITLE", "Get a release by tag name"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("owner",
+ mcp.Required(),
+ mcp.Description("Repository owner"),
+ ),
+ mcp.WithString("repo",
+ mcp.Required(),
+ mcp.Description("Repository name"),
+ ),
+ mcp.WithString("tag",
+ mcp.Required(),
+ mcp.Description("Tag name (e.g., 'v1.0.0')"),
+ ),
+ ),
+ func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ owner, err := RequiredParam[string](request, "owner")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ repo, err := RequiredParam[string](request, "repo")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ tag, err := RequiredParam[string](request, "tag")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ release, resp, err := client.Repositories.GetReleaseByTag(ctx, owner, repo, tag)
+ if err != nil {
+ return ghErrors.NewGitHubAPIErrorResponse(ctx,
+ fmt.Sprintf("failed to get release by tag: %s", tag),
+ resp,
+ err,
+ ), nil
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to get release by tag: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(release)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal response: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
// filterPaths filters the entries in a GitHub tree to find paths that
// match the given suffix.
// maxResults limits the number of results returned to first maxResults entries,
@@ -1358,36 +1544,100 @@ func filterPaths(entries []*github.TreeEntry, path string, maxResults int) []str
return matchedPaths
}
-// resolveGitReference resolves git references with the following logic:
-// 1. If SHA is provided, it takes precedence
-// 2. If neither is provided, use the default branch as ref
-// 3. Get commit SHA from the ref
-// Refs can look like `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head`
-// The function returns the resolved ref, commit SHA and any error.
+// resolveGitReference takes a user-provided ref and sha and resolves them into a
+// definitive commit SHA and its corresponding fully-qualified reference.
+//
+// The resolution logic follows a clear priority:
+//
+// 1. If a specific commit `sha` is provided, it takes precedence and is used directly,
+// and all reference resolution is skipped.
+//
+// 2. If no `sha` is provided, the function resolves the `ref`
+// string into a fully-qualified format (e.g., "refs/heads/main") by trying
+// the following steps in order:
+// a). **Empty Ref:** If `ref` is empty, the repository's default branch is used.
+// b). **Fully-Qualified:** If `ref` already starts with "refs/", it's considered fully
+// qualified and used as-is.
+// c). **Partially-Qualified:** If `ref` starts with "heads/" or "tags/", it is
+// prefixed with "refs/" to make it fully-qualified.
+// d). **Short Name:** Otherwise, the `ref` is treated as a short name. The function
+// first attempts to resolve it as a branch ("refs/heads/["). If that
+// returns a 404 Not Found error, it then attempts to resolve it as a tag
+// ("refs/tags/][").
+//
+// 3. **Final Lookup:** Once a fully-qualified ref is determined, a final API call
+// is made to fetch that reference's definitive commit SHA.
+//
+// Any unexpected (non-404) errors during the resolution process are returned
+// immediately. All API errors are logged with rich context to aid diagnostics.
func resolveGitReference(ctx context.Context, githubClient *github.Client, owner, repo, ref, sha string) (*raw.ContentOpts, error) {
- // 1. If SHA is provided, use it directly
+ // 1) If SHA explicitly provided, it's the highest priority.
if sha != "" {
return &raw.ContentOpts{Ref: "", SHA: sha}, nil
}
- // 2. If neither provided, use the default branch as ref
- if ref == "" {
+ originalRef := ref // Keep original ref for clearer error messages down the line.
+
+ // 2) If no SHA is provided, we try to resolve the ref into a fully-qualified format.
+ var reference *github.Reference
+ var resp *github.Response
+ var err error
+
+ switch {
+ case originalRef == "":
+ // 2a) If ref is empty, determine the default branch.
repoInfo, resp, err := githubClient.Repositories.Get(ctx, owner, repo)
if err != nil {
_, _ = ghErrors.NewGitHubAPIErrorToCtx(ctx, "failed to get repository info", resp, err)
return nil, fmt.Errorf("failed to get repository info: %w", err)
}
ref = fmt.Sprintf("refs/heads/%s", repoInfo.GetDefaultBranch())
+ case strings.HasPrefix(originalRef, "refs/"):
+ // 2b) Already fully qualified. The reference will be fetched at the end.
+ case strings.HasPrefix(originalRef, "heads/") || strings.HasPrefix(originalRef, "tags/"):
+ // 2c) Partially qualified. Make it fully qualified.
+ ref = "refs/" + originalRef
+ default:
+ // 2d) It's a short name, so we try to resolve it to either a branch or a tag.
+ branchRef := "refs/heads/" + originalRef
+ reference, resp, err = githubClient.Git.GetRef(ctx, owner, repo, branchRef)
+
+ if err == nil {
+ ref = branchRef // It's a branch.
+ } else {
+ // The branch lookup failed. Check if it was a 404 Not Found error.
+ ghErr, isGhErr := err.(*github.ErrorResponse)
+ if isGhErr && ghErr.Response.StatusCode == http.StatusNotFound {
+ tagRef := "refs/tags/" + originalRef
+ reference, resp, err = githubClient.Git.GetRef(ctx, owner, repo, tagRef)
+ if err == nil {
+ ref = tagRef // It's a tag.
+ } else {
+ // The tag lookup also failed. Check if it was a 404 Not Found error.
+ ghErr2, isGhErr2 := err.(*github.ErrorResponse)
+ if isGhErr2 && ghErr2.Response.StatusCode == http.StatusNotFound {
+ return nil, fmt.Errorf("could not resolve ref %q as a branch or a tag", originalRef)
+ }
+ // The tag lookup failed for a different reason.
+ _, _ = ghErrors.NewGitHubAPIErrorToCtx(ctx, "failed to get reference (tag)", resp, err)
+ return nil, fmt.Errorf("failed to get reference for tag '%s': %w", originalRef, err)
+ }
+ } else {
+ // The branch lookup failed for a different reason.
+ _, _ = ghErrors.NewGitHubAPIErrorToCtx(ctx, "failed to get reference (branch)", resp, err)
+ return nil, fmt.Errorf("failed to get reference for branch '%s': %w", originalRef, err)
+ }
+ }
}
- // 3. Get the SHA from the ref
- reference, resp, err := githubClient.Git.GetRef(ctx, owner, repo, ref)
- if err != nil {
- _, _ = ghErrors.NewGitHubAPIErrorToCtx(ctx, "failed to get reference", resp, err)
- return nil, fmt.Errorf("failed to get reference: %w", err)
+ if reference == nil {
+ reference, resp, err = githubClient.Git.GetRef(ctx, owner, repo, ref)
+ if err != nil {
+ _, _ = ghErrors.NewGitHubAPIErrorToCtx(ctx, "failed to get final reference", resp, err)
+ return nil, fmt.Errorf("failed to get final reference for %q: %w", ref, err)
+ }
}
- sha = reference.GetObject().GetSHA()
- // Use provided ref, or it will be empty which defaults to the default branch
+ sha = reference.GetObject().GetSHA()
return &raw.ContentOpts{Ref: ref, SHA: sha}, nil
}
diff --git a/pkg/github/repositories_test.go b/pkg/github/repositories_test.go
index 2e522b426..f5ebfd32b 100644
--- a/pkg/github/repositories_test.go
+++ b/pkg/github/repositories_test.go
@@ -6,6 +6,7 @@ import (
"encoding/json"
"net/http"
"net/url"
+ "strings"
"testing"
"time"
@@ -2113,6 +2114,344 @@ func Test_GetTag(t *testing.T) {
}
}
+func Test_ListReleases(t *testing.T) {
+ mockClient := github.NewClient(nil)
+ tool, _ := ListReleases(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "list_releases", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "owner")
+ assert.Contains(t, tool.InputSchema.Properties, "repo")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo"})
+
+ mockReleases := []*github.RepositoryRelease{
+ {
+ ID: github.Ptr(int64(1)),
+ TagName: github.Ptr("v1.0.0"),
+ Name: github.Ptr("First Release"),
+ },
+ {
+ ID: github.Ptr(int64(2)),
+ TagName: github.Ptr("v0.9.0"),
+ Name: github.Ptr("Beta Release"),
+ },
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedResult []*github.RepositoryRelease
+ expectedErrMsg string
+ }{
+ {
+ name: "successful releases list",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetReposReleasesByOwnerByRepo,
+ mockReleases,
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: false,
+ expectedResult: mockReleases,
+ },
+ {
+ name: "releases list fails",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposReleasesByOwnerByRepo,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to list releases",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ client := github.NewClient(tc.mockedClient)
+ _, handler := ListReleases(stubGetClientFn(client), translations.NullTranslationHelper)
+ request := createMCPRequest(tc.requestArgs)
+ result, err := handler(context.Background(), request)
+
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+ textContent := getTextResult(t, result)
+ var returnedReleases []*github.RepositoryRelease
+ err = json.Unmarshal([]byte(textContent.Text), &returnedReleases)
+ require.NoError(t, err)
+ assert.Len(t, returnedReleases, len(tc.expectedResult))
+ for i, rel := range returnedReleases {
+ assert.Equal(t, *tc.expectedResult[i].TagName, *rel.TagName)
+ }
+ })
+ }
+}
+func Test_GetLatestRelease(t *testing.T) {
+ mockClient := github.NewClient(nil)
+ tool, _ := GetLatestRelease(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "get_latest_release", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "owner")
+ assert.Contains(t, tool.InputSchema.Properties, "repo")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo"})
+
+ mockRelease := &github.RepositoryRelease{
+ ID: github.Ptr(int64(1)),
+ TagName: github.Ptr("v1.0.0"),
+ Name: github.Ptr("First Release"),
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedResult *github.RepositoryRelease
+ expectedErrMsg string
+ }{
+ {
+ name: "successful latest release fetch",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetReposReleasesLatestByOwnerByRepo,
+ mockRelease,
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: false,
+ expectedResult: mockRelease,
+ },
+ {
+ name: "latest release fetch fails",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposReleasesLatestByOwnerByRepo,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to get latest release",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ client := github.NewClient(tc.mockedClient)
+ _, handler := GetLatestRelease(stubGetClientFn(client), translations.NullTranslationHelper)
+ request := createMCPRequest(tc.requestArgs)
+ result, err := handler(context.Background(), request)
+
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+ textContent := getTextResult(t, result)
+ var returnedRelease github.RepositoryRelease
+ err = json.Unmarshal([]byte(textContent.Text), &returnedRelease)
+ require.NoError(t, err)
+ assert.Equal(t, *tc.expectedResult.TagName, *returnedRelease.TagName)
+ })
+ }
+}
+
+func Test_GetReleaseByTag(t *testing.T) {
+ mockClient := github.NewClient(nil)
+ tool, _ := GetReleaseByTag(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+ require.NoError(t, toolsnaps.Test(tool.Name, tool))
+
+ assert.Equal(t, "get_release_by_tag", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "owner")
+ assert.Contains(t, tool.InputSchema.Properties, "repo")
+ assert.Contains(t, tool.InputSchema.Properties, "tag")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo", "tag"})
+
+ mockRelease := &github.RepositoryRelease{
+ ID: github.Ptr(int64(1)),
+ TagName: github.Ptr("v1.0.0"),
+ Name: github.Ptr("Release v1.0.0"),
+ Body: github.Ptr("This is the first stable release."),
+ Assets: []*github.ReleaseAsset{
+ {
+ ID: github.Ptr(int64(1)),
+ Name: github.Ptr("release-v1.0.0.tar.gz"),
+ },
+ },
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedResult *github.RepositoryRelease
+ expectedErrMsg string
+ }{
+ {
+ name: "successful release by tag fetch",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetReposReleasesTagsByOwnerByRepoByTag,
+ mockRelease,
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ "tag": "v1.0.0",
+ },
+ expectError: false,
+ expectedResult: mockRelease,
+ },
+ {
+ name: "missing owner parameter",
+ mockedClient: mock.NewMockedHTTPClient(),
+ requestArgs: map[string]interface{}{
+ "repo": "repo",
+ "tag": "v1.0.0",
+ },
+ expectError: false, // Returns tool error, not Go error
+ expectedErrMsg: "missing required parameter: owner",
+ },
+ {
+ name: "missing repo parameter",
+ mockedClient: mock.NewMockedHTTPClient(),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "tag": "v1.0.0",
+ },
+ expectError: false, // Returns tool error, not Go error
+ expectedErrMsg: "missing required parameter: repo",
+ },
+ {
+ name: "missing tag parameter",
+ mockedClient: mock.NewMockedHTTPClient(),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: false, // Returns tool error, not Go error
+ expectedErrMsg: "missing required parameter: tag",
+ },
+ {
+ name: "release by tag not found",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposReleasesTagsByOwnerByRepoByTag,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ "tag": "v999.0.0",
+ },
+ expectError: false, // API errors return tool errors, not Go errors
+ expectedErrMsg: "failed to get release by tag: v999.0.0",
+ },
+ {
+ name: "server error",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposReleasesTagsByOwnerByRepoByTag,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusInternalServerError)
+ _, _ = w.Write([]byte(`{"message": "Internal Server Error"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ "tag": "v1.0.0",
+ },
+ expectError: false, // API errors return tool errors, not Go errors
+ expectedErrMsg: "failed to get release by tag: v1.0.0",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ client := github.NewClient(tc.mockedClient)
+ _, handler := GetReleaseByTag(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ request := createMCPRequest(tc.requestArgs)
+
+ result, err := handler(context.Background(), request)
+
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+
+ if tc.expectedErrMsg != "" {
+ require.True(t, result.IsError)
+ errorContent := getErrorResult(t, result)
+ assert.Contains(t, errorContent.Text, tc.expectedErrMsg)
+ return
+ }
+
+ require.False(t, result.IsError)
+
+ textContent := getTextResult(t, result)
+
+ var returnedRelease github.RepositoryRelease
+ err = json.Unmarshal([]byte(textContent.Text), &returnedRelease)
+ require.NoError(t, err)
+
+ assert.Equal(t, *tc.expectedResult.ID, *returnedRelease.ID)
+ assert.Equal(t, *tc.expectedResult.TagName, *returnedRelease.TagName)
+ assert.Equal(t, *tc.expectedResult.Name, *returnedRelease.Name)
+ if tc.expectedResult.Body != nil {
+ assert.Equal(t, *tc.expectedResult.Body, *returnedRelease.Body)
+ }
+ if len(tc.expectedResult.Assets) > 0 {
+ require.Len(t, returnedRelease.Assets, len(tc.expectedResult.Assets))
+ assert.Equal(t, *tc.expectedResult.Assets[0].Name, *returnedRelease.Assets[0].Name)
+ }
+ })
+ }
+}
+
func Test_filterPaths(t *testing.T) {
tests := []struct {
name string
@@ -2212,63 +2551,239 @@ func Test_resolveGitReference(t *testing.T) {
ctx := context.Background()
owner := "owner"
repo := "repo"
- mockedClient := mock.NewMockedHTTPClient(
- mock.WithRequestMatchHandler(
- mock.GetReposByOwnerByRepo,
- http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
- w.WriteHeader(http.StatusOK)
- _, _ = w.Write([]byte(`{"name": "repo", "default_branch": "main"}`))
- }),
- ),
- mock.WithRequestMatchHandler(
- mock.GetReposGitRefByOwnerByRepoByRef,
- http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
- w.WriteHeader(http.StatusOK)
- _, _ = w.Write([]byte(`{"ref": "refs/heads/main", "object": {"sha": "123sha456"}}`))
- }),
- ),
- )
tests := []struct {
name string
ref string
sha string
+ mockSetup func() *http.Client
expectedOutput *raw.ContentOpts
+ expectError bool
+ errorContains string
}{
{
name: "sha takes precedence over ref",
ref: "refs/heads/main",
sha: "123sha456",
+ mockSetup: func() *http.Client {
+ // No API calls should be made when SHA is provided
+ return mock.NewMockedHTTPClient()
+ },
expectedOutput: &raw.ContentOpts{
SHA: "123sha456",
},
+ expectError: false,
},
{
name: "use default branch if ref and sha both empty",
ref: "",
sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposByOwnerByRepo,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"name": "repo", "default_branch": "main"}`))
+ }),
+ ),
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Contains(t, r.URL.Path, "/git/ref/heads/main")
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/heads/main", "object": {"sha": "main-sha"}}`))
+ }),
+ ),
+ )
+ },
expectedOutput: &raw.ContentOpts{
Ref: "refs/heads/main",
- SHA: "123sha456",
+ SHA: "main-sha",
},
+ expectError: false,
},
{
- name: "get SHA from ref",
- ref: "refs/heads/main",
+ name: "fully qualified ref passed through unchanged",
+ ref: "refs/heads/feature-branch",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Contains(t, r.URL.Path, "/git/ref/heads/feature-branch")
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/heads/feature-branch", "object": {"sha": "feature-sha"}}`))
+ }),
+ ),
+ )
+ },
+ expectedOutput: &raw.ContentOpts{
+ Ref: "refs/heads/feature-branch",
+ SHA: "feature-sha",
+ },
+ expectError: false,
+ },
+ {
+ name: "short branch name resolves to refs/heads/",
+ ref: "main",
sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ if strings.Contains(r.URL.Path, "/git/ref/heads/main") {
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/heads/main", "object": {"sha": "main-sha"}}`))
+ } else {
+ t.Errorf("Unexpected path: %s", r.URL.Path)
+ w.WriteHeader(http.StatusNotFound)
+ }
+ }),
+ ),
+ )
+ },
expectedOutput: &raw.ContentOpts{
Ref: "refs/heads/main",
- SHA: "123sha456",
+ SHA: "main-sha",
+ },
+ expectError: false,
+ },
+ {
+ name: "short tag name falls back to refs/tags/ when branch not found",
+ ref: "v1.0.0",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ switch {
+ case strings.Contains(r.URL.Path, "/git/ref/heads/v1.0.0"):
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ case strings.Contains(r.URL.Path, "/git/ref/tags/v1.0.0"):
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/tags/v1.0.0", "object": {"sha": "tag-sha"}}`))
+ default:
+ t.Errorf("Unexpected path: %s", r.URL.Path)
+ w.WriteHeader(http.StatusNotFound)
+ }
+ }),
+ ),
+ )
+ },
+ expectedOutput: &raw.ContentOpts{
+ Ref: "refs/tags/v1.0.0",
+ SHA: "tag-sha",
+ },
+ expectError: false,
+ },
+ {
+ name: "heads/ prefix gets refs/ prepended",
+ ref: "heads/feature-branch",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Contains(t, r.URL.Path, "/git/ref/heads/feature-branch")
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/heads/feature-branch", "object": {"sha": "feature-sha"}}`))
+ }),
+ ),
+ )
+ },
+ expectedOutput: &raw.ContentOpts{
+ Ref: "refs/heads/feature-branch",
+ SHA: "feature-sha",
+ },
+ expectError: false,
+ },
+ {
+ name: "tags/ prefix gets refs/ prepended",
+ ref: "tags/v1.0.0",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Contains(t, r.URL.Path, "/git/ref/tags/v1.0.0")
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/tags/v1.0.0", "object": {"sha": "tag-sha"}}`))
+ }),
+ ),
+ )
+ },
+ expectedOutput: &raw.ContentOpts{
+ Ref: "refs/tags/v1.0.0",
+ SHA: "tag-sha",
+ },
+ expectError: false,
+ },
+ {
+ name: "invalid short name that doesn't exist as branch or tag",
+ ref: "nonexistent",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ // Both branch and tag attempts should return 404
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ }),
+ ),
+ )
+ },
+ expectError: true,
+ errorContains: "could not resolve ref \"nonexistent\" as a branch or a tag",
+ },
+ {
+ name: "fully qualified pull request ref",
+ ref: "refs/pull/123/head",
+ sha: "",
+ mockSetup: func() *http.Client {
+ return mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetReposGitRefByOwnerByRepoByRef,
+ http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Contains(t, r.URL.Path, "/git/ref/pull/123/head")
+ w.WriteHeader(http.StatusOK)
+ _, _ = w.Write([]byte(`{"ref": "refs/pull/123/head", "object": {"sha": "pr-sha"}}`))
+ }),
+ ),
+ )
},
+ expectedOutput: &raw.ContentOpts{
+ Ref: "refs/pull/123/head",
+ SHA: "pr-sha",
+ },
+ expectError: false,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
- client := github.NewClient(mockedClient)
+ client := github.NewClient(tc.mockSetup())
opts, err := resolveGitReference(ctx, client, owner, repo, tc.ref, tc.sha)
+
+ if tc.expectError {
+ require.Error(t, err)
+ if tc.errorContains != "" {
+ assert.Contains(t, err.Error(), tc.errorContains)
+ }
+ return
+ }
+
require.NoError(t, err)
+ require.NotNil(t, opts)
if tc.expectedOutput.SHA != "" {
assert.Equal(t, tc.expectedOutput.SHA, opts.SHA)
diff --git a/pkg/github/search.go b/pkg/github/search.go
index 4fe390f86..248f17e17 100644
--- a/pkg/github/search.go
+++ b/pkg/github/search.go
@@ -204,7 +204,10 @@ func userOrOrgHandler(accountType string, getClient GetClientFn) server.ToolHand
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
- searchQuery := "type:" + accountType + " " + query
+ searchQuery := query
+ if !hasTypeFilter(query) {
+ searchQuery = "type:" + accountType + " " + query
+ }
result, resp, err := client.Search.Users(ctx, searchQuery, opts)
if err != nil {
return ghErrors.NewGitHubAPIErrorResponse(ctx,
diff --git a/pkg/github/search_test.go b/pkg/github/search_test.go
index 66b57a8d4..cfc87c02b 100644
--- a/pkg/github/search_test.go
+++ b/pkg/github/search_test.go
@@ -410,6 +410,46 @@ func Test_SearchUsers(t *testing.T) {
expectError: false,
expectedResult: mockSearchResult,
},
+ {
+ name: "query with existing type:user filter - no duplication",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchUsers,
+ expectQueryParams(t, map[string]string{
+ "q": "type:user location:seattle followers:>100",
+ "page": "1",
+ "per_page": "30",
+ }).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "type:user location:seattle followers:>100",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "complex query with existing type:user filter and OR operators",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchUsers,
+ expectQueryParams(t, map[string]string{
+ "q": "type:user (location:seattle OR location:california) followers:>50",
+ "page": "1",
+ "per_page": "30",
+ }).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "type:user (location:seattle OR location:california) followers:>50",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
{
name: "search users fails",
mockedClient: mock.NewMockedHTTPClient(
@@ -537,6 +577,46 @@ func Test_SearchOrgs(t *testing.T) {
expectError: false,
expectedResult: mockSearchResult,
},
+ {
+ name: "query with existing type:org filter - no duplication",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchUsers,
+ expectQueryParams(t, map[string]string{
+ "q": "type:org location:california followers:>1000",
+ "page": "1",
+ "per_page": "30",
+ }).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "type:org location:california followers:>1000",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
+ {
+ name: "complex query with existing type:org filter and OR operators",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchUsers,
+ expectQueryParams(t, map[string]string{
+ "q": "type:org (location:seattle OR location:california OR location:newyork) repos:>10",
+ "page": "1",
+ "per_page": "30",
+ }).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "query": "type:org (location:seattle OR location:california OR location:newyork) repos:>10",
+ },
+ expectError: false,
+ expectedResult: mockSearchResult,
+ },
{
name: "org search fails",
mockedClient: mock.NewMockedHTTPClient(
diff --git a/pkg/github/search_utils.go b/pkg/github/search_utils.go
index 014b57249..159518c91 100644
--- a/pkg/github/search_utils.go
+++ b/pkg/github/search_utils.go
@@ -6,11 +6,35 @@ import (
"fmt"
"io"
"net/http"
+ "regexp"
"github.com/google/go-github/v74/github"
"github.com/mark3labs/mcp-go/mcp"
)
+func hasFilter(query, filterType string) bool {
+ // Match filter at start of string, after whitespace, or after non-word characters like '('
+ pattern := fmt.Sprintf(`(^|\s|\W)%s:\S+`, regexp.QuoteMeta(filterType))
+ matched, _ := regexp.MatchString(pattern, query)
+ return matched
+}
+
+func hasSpecificFilter(query, filterType, filterValue string) bool {
+ // Match specific filter:value at start, after whitespace, or after non-word characters
+ // End with word boundary, whitespace, or non-word characters like ')'
+ pattern := fmt.Sprintf(`(^|\s|\W)%s:%s($|\s|\W)`, regexp.QuoteMeta(filterType), regexp.QuoteMeta(filterValue))
+ matched, _ := regexp.MatchString(pattern, query)
+ return matched
+}
+
+func hasRepoFilter(query string) bool {
+ return hasFilter(query, "repo")
+}
+
+func hasTypeFilter(query string) bool {
+ return hasFilter(query, "type")
+}
+
func searchHandler(
ctx context.Context,
getClient GetClientFn,
@@ -22,7 +46,10 @@ func searchHandler(
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
- query = fmt.Sprintf("is:%s %s", searchType, query)
+
+ if !hasSpecificFilter(query, "is", searchType) {
+ query = fmt.Sprintf("is:%s %s", searchType, query)
+ }
owner, err := OptionalParam[string](request, "owner")
if err != nil {
@@ -34,7 +61,7 @@ func searchHandler(
return mcp.NewToolResultError(err.Error()), nil
}
- if owner != "" && repo != "" {
+ if owner != "" && repo != "" && !hasRepoFilter(query) {
query = fmt.Sprintf("repo:%s/%s %s", owner, repo, query)
}
diff --git a/pkg/github/search_utils_test.go b/pkg/github/search_utils_test.go
new file mode 100644
index 000000000..85f953eed
--- /dev/null
+++ b/pkg/github/search_utils_test.go
@@ -0,0 +1,352 @@
+package github
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+)
+
+func Test_hasFilter(t *testing.T) {
+ tests := []struct {
+ name string
+ query string
+ filterType string
+ expected bool
+ }{
+ {
+ name: "query has is:issue filter",
+ query: "is:issue bug report",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query has repo: filter",
+ query: "repo:github/github-mcp-server critical bug",
+ filterType: "repo",
+ expected: true,
+ },
+ {
+ name: "query has multiple is: filters",
+ query: "is:issue is:open bug",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query has filter at the beginning",
+ query: "is:issue some text",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query has filter in the middle",
+ query: "some text is:issue more text",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query has filter at the end",
+ query: "some text is:issue",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query does not have the filter",
+ query: "bug report critical",
+ filterType: "is",
+ expected: false,
+ },
+ {
+ name: "query has similar text but not the filter",
+ query: "this issue is important",
+ filterType: "is",
+ expected: false,
+ },
+ {
+ name: "empty query",
+ query: "",
+ filterType: "is",
+ expected: false,
+ },
+ {
+ name: "query has label: filter but looking for is:",
+ query: "label:bug critical",
+ filterType: "is",
+ expected: false,
+ },
+ {
+ name: "query has author: filter",
+ query: "author:octocat bug",
+ filterType: "author",
+ expected: true,
+ },
+ {
+ name: "query with complex OR expression",
+ query: "repo:github/github-mcp-server is:issue (label:critical OR label:urgent)",
+ filterType: "is",
+ expected: true,
+ },
+ {
+ name: "query with complex OR expression checking repo",
+ query: "repo:github/github-mcp-server is:issue (label:critical OR label:urgent)",
+ filterType: "repo",
+ expected: true,
+ },
+ {
+ name: "filter in parentheses at start",
+ query: "(label:bug OR owner:bob) is:issue",
+ filterType: "label",
+ expected: true,
+ },
+ {
+ name: "filter after opening parenthesis",
+ query: "is:issue (label:critical OR repo:test/test)",
+ filterType: "label",
+ expected: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ result := hasFilter(tt.query, tt.filterType)
+ assert.Equal(t, tt.expected, result, "hasFilter(%q, %q) = %v, expected %v", tt.query, tt.filterType, result, tt.expected)
+ })
+ }
+}
+
+func Test_hasRepoFilter(t *testing.T) {
+ tests := []struct {
+ name string
+ query string
+ expected bool
+ }{
+ {
+ name: "query with repo: filter at beginning",
+ query: "repo:github/github-mcp-server is:issue",
+ expected: true,
+ },
+ {
+ name: "query with repo: filter in middle",
+ query: "is:issue repo:octocat/Hello-World bug",
+ expected: true,
+ },
+ {
+ name: "query with repo: filter at end",
+ query: "is:issue critical repo:owner/repo-name",
+ expected: true,
+ },
+ {
+ name: "query with complex repo name",
+ query: "repo:microsoft/vscode-extension-samples bug",
+ expected: true,
+ },
+ {
+ name: "query without repo: filter",
+ query: "is:issue bug critical",
+ expected: false,
+ },
+ {
+ name: "query with malformed repo: filter (no slash)",
+ query: "repo:github bug",
+ expected: true, // hasRepoFilter only checks for repo: prefix, not format
+ },
+ {
+ name: "empty query",
+ query: "",
+ expected: false,
+ },
+ {
+ name: "query with multiple repo: filters",
+ query: "repo:github/first repo:octocat/second",
+ expected: true,
+ },
+ {
+ name: "query with repo: in text but not as filter",
+ query: "this repo: is important",
+ expected: false,
+ },
+ {
+ name: "query with complex OR expression",
+ query: "repo:github/github-mcp-server is:issue (label:critical OR label:urgent)",
+ expected: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ result := hasRepoFilter(tt.query)
+ assert.Equal(t, tt.expected, result, "hasRepoFilter(%q) = %v, expected %v", tt.query, result, tt.expected)
+ })
+ }
+}
+
+func Test_hasSpecificFilter(t *testing.T) {
+ tests := []struct {
+ name string
+ query string
+ filterType string
+ filterValue string
+ expected bool
+ }{
+ {
+ name: "query has exact is:issue filter",
+ query: "is:issue bug report",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "query has is:open but looking for is:issue",
+ query: "is:open bug report",
+ filterType: "is",
+ filterValue: "issue",
+ expected: false,
+ },
+ {
+ name: "query has both is:issue and is:open, looking for is:issue",
+ query: "is:issue is:open bug",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "query has both is:issue and is:open, looking for is:open",
+ query: "is:issue is:open bug",
+ filterType: "is",
+ filterValue: "open",
+ expected: true,
+ },
+ {
+ name: "query has is:issue at the beginning",
+ query: "is:issue some text",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "query has is:issue in the middle",
+ query: "some text is:issue more text",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "query has is:issue at the end",
+ query: "some text is:issue",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "query does not have is:issue",
+ query: "bug report critical",
+ filterType: "is",
+ filterValue: "issue",
+ expected: false,
+ },
+ {
+ name: "query has similar text but not the exact filter",
+ query: "this issue is important",
+ filterType: "is",
+ filterValue: "issue",
+ expected: false,
+ },
+ {
+ name: "empty query",
+ query: "",
+ filterType: "is",
+ filterValue: "issue",
+ expected: false,
+ },
+ {
+ name: "partial match should not count",
+ query: "is:issues bug", // "issues" vs "issue"
+ filterType: "is",
+ filterValue: "issue",
+ expected: false,
+ },
+ {
+ name: "complex query with parentheses",
+ query: "repo:github/github-mcp-server is:issue (label:critical OR label:urgent)",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "filter:value in parentheses at start",
+ query: "(is:issue OR is:pr) label:bug",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ {
+ name: "filter:value after opening parenthesis",
+ query: "repo:test/repo (is:issue AND label:bug)",
+ filterType: "is",
+ filterValue: "issue",
+ expected: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ result := hasSpecificFilter(tt.query, tt.filterType, tt.filterValue)
+ assert.Equal(t, tt.expected, result, "hasSpecificFilter(%q, %q, %q) = %v, expected %v", tt.query, tt.filterType, tt.filterValue, result, tt.expected)
+ })
+ }
+}
+
+func Test_hasTypeFilter(t *testing.T) {
+ tests := []struct {
+ name string
+ query string
+ expected bool
+ }{
+ {
+ name: "query with type:user filter at beginning",
+ query: "type:user location:seattle",
+ expected: true,
+ },
+ {
+ name: "query with type:org filter in middle",
+ query: "location:california type:org followers:>100",
+ expected: true,
+ },
+ {
+ name: "query with type:user filter at end",
+ query: "location:seattle followers:>50 type:user",
+ expected: true,
+ },
+ {
+ name: "query without type: filter",
+ query: "location:seattle followers:>50",
+ expected: false,
+ },
+ {
+ name: "empty query",
+ query: "",
+ expected: false,
+ },
+ {
+ name: "query with type: in text but not as filter",
+ query: "this type: is important",
+ expected: false,
+ },
+ {
+ name: "query with multiple type: filters",
+ query: "type:user type:org",
+ expected: true,
+ },
+ {
+ name: "complex query with OR expression",
+ query: "type:user (location:seattle OR location:california)",
+ expected: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ result := hasTypeFilter(tt.query)
+ assert.Equal(t, tt.expected, result, "hasTypeFilter(%q) = %v, expected %v", tt.query, result, tt.expected)
+ })
+ }
+}
diff --git a/pkg/github/security_advisories.go b/pkg/github/security_advisories.go
new file mode 100644
index 000000000..6eaeebe47
--- /dev/null
+++ b/pkg/github/security_advisories.go
@@ -0,0 +1,397 @@
+package github
+
+import (
+ "context"
+ "encoding/json"
+ "fmt"
+ "io"
+ "net/http"
+
+ "github.com/github/github-mcp-server/pkg/translations"
+ "github.com/google/go-github/v74/github"
+ "github.com/mark3labs/mcp-go/mcp"
+ "github.com/mark3labs/mcp-go/server"
+)
+
+func ListGlobalSecurityAdvisories(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("list_global_security_advisories",
+ mcp.WithDescription(t("TOOL_LIST_GLOBAL_SECURITY_ADVISORIES_DESCRIPTION", "List global security advisories from GitHub.")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_LIST_GLOBAL_SECURITY_ADVISORIES_USER_TITLE", "List global security advisories"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("ghsaId",
+ mcp.Description("Filter by GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx)."),
+ ),
+ mcp.WithString("type",
+ mcp.Description("Advisory type."),
+ mcp.Enum("reviewed", "malware", "unreviewed"),
+ mcp.DefaultString("reviewed"),
+ ),
+ mcp.WithString("cveId",
+ mcp.Description("Filter by CVE ID."),
+ ),
+ mcp.WithString("ecosystem",
+ mcp.Description("Filter by package ecosystem."),
+ mcp.Enum("actions", "composer", "erlang", "go", "maven", "npm", "nuget", "other", "pip", "pub", "rubygems", "rust"),
+ ),
+ mcp.WithString("severity",
+ mcp.Description("Filter by severity."),
+ mcp.Enum("unknown", "low", "medium", "high", "critical"),
+ ),
+ mcp.WithArray("cwes",
+ mcp.Description("Filter by Common Weakness Enumeration IDs (e.g. [\"79\", \"284\", \"22\"])."),
+ mcp.Items(map[string]any{
+ "type": "string",
+ }),
+ ),
+ mcp.WithBoolean("isWithdrawn",
+ mcp.Description("Whether to only return withdrawn advisories."),
+ ),
+ mcp.WithString("affects",
+ mcp.Description("Filter advisories by affected package or version (e.g. \"package1,package2@1.0.0\")."),
+ ),
+ mcp.WithString("published",
+ mcp.Description("Filter by publish date or date range (ISO 8601 date or range)."),
+ ),
+ mcp.WithString("updated",
+ mcp.Description("Filter by update date or date range (ISO 8601 date or range)."),
+ ),
+ mcp.WithString("modified",
+ mcp.Description("Filter by publish or update date or date range (ISO 8601 date or range)."),
+ ),
+ ), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ ghsaID, err := OptionalParam[string](request, "ghsaId")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid ghsaId: %v", err)), nil
+ }
+
+ typ, err := OptionalParam[string](request, "type")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid type: %v", err)), nil
+ }
+
+ cveID, err := OptionalParam[string](request, "cveId")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid cveId: %v", err)), nil
+ }
+
+ eco, err := OptionalParam[string](request, "ecosystem")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid ecosystem: %v", err)), nil
+ }
+
+ sev, err := OptionalParam[string](request, "severity")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid severity: %v", err)), nil
+ }
+
+ cwes, err := OptionalParam[[]string](request, "cwes")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid cwes: %v", err)), nil
+ }
+
+ isWithdrawn, err := OptionalParam[bool](request, "isWithdrawn")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid isWithdrawn: %v", err)), nil
+ }
+
+ affects, err := OptionalParam[string](request, "affects")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid affects: %v", err)), nil
+ }
+
+ published, err := OptionalParam[string](request, "published")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid published: %v", err)), nil
+ }
+
+ updated, err := OptionalParam[string](request, "updated")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid updated: %v", err)), nil
+ }
+
+ modified, err := OptionalParam[string](request, "modified")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid modified: %v", err)), nil
+ }
+
+ opts := &github.ListGlobalSecurityAdvisoriesOptions{}
+
+ if ghsaID != "" {
+ opts.GHSAID = &ghsaID
+ }
+ if typ != "" {
+ opts.Type = &typ
+ }
+ if cveID != "" {
+ opts.CVEID = &cveID
+ }
+ if eco != "" {
+ opts.Ecosystem = &eco
+ }
+ if sev != "" {
+ opts.Severity = &sev
+ }
+ if len(cwes) > 0 {
+ opts.CWEs = cwes
+ }
+
+ if isWithdrawn {
+ opts.IsWithdrawn = &isWithdrawn
+ }
+
+ if affects != "" {
+ opts.Affects = &affects
+ }
+ if published != "" {
+ opts.Published = &published
+ }
+ if updated != "" {
+ opts.Updated = &updated
+ }
+ if modified != "" {
+ opts.Modified = &modified
+ }
+
+ advisories, resp, err := client.SecurityAdvisories.ListGlobalSecurityAdvisories(ctx, opts)
+ if err != nil {
+ return nil, fmt.Errorf("failed to list global security advisories: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to list advisories: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(advisories)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal advisories: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
+func ListRepositorySecurityAdvisories(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("list_repository_security_advisories",
+ mcp.WithDescription(t("TOOL_LIST_REPOSITORY_SECURITY_ADVISORIES_DESCRIPTION", "List repository security advisories for a GitHub repository.")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_LIST_REPOSITORY_SECURITY_ADVISORIES_USER_TITLE", "List repository security advisories"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("owner",
+ mcp.Required(),
+ mcp.Description("The owner of the repository."),
+ ),
+ mcp.WithString("repo",
+ mcp.Required(),
+ mcp.Description("The name of the repository."),
+ ),
+ mcp.WithString("direction",
+ mcp.Description("Sort direction."),
+ mcp.Enum("asc", "desc"),
+ ),
+ mcp.WithString("sort",
+ mcp.Description("Sort field."),
+ mcp.Enum("created", "updated", "published"),
+ ),
+ mcp.WithString("state",
+ mcp.Description("Filter by advisory state."),
+ mcp.Enum("triage", "draft", "published", "closed"),
+ ),
+ ), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ owner, err := RequiredParam[string](request, "owner")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ repo, err := RequiredParam[string](request, "repo")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ direction, err := OptionalParam[string](request, "direction")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ sortField, err := OptionalParam[string](request, "sort")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ state, err := OptionalParam[string](request, "state")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ opts := &github.ListRepositorySecurityAdvisoriesOptions{}
+ if direction != "" {
+ opts.Direction = direction
+ }
+ if sortField != "" {
+ opts.Sort = sortField
+ }
+ if state != "" {
+ opts.State = state
+ }
+
+ advisories, resp, err := client.SecurityAdvisories.ListRepositorySecurityAdvisories(ctx, owner, repo, opts)
+ if err != nil {
+ return nil, fmt.Errorf("failed to list repository security advisories: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to list repository advisories: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(advisories)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal advisories: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
+func GetGlobalSecurityAdvisory(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("get_global_security_advisory",
+ mcp.WithDescription(t("TOOL_GET_GLOBAL_SECURITY_ADVISORY_DESCRIPTION", "Get a global security advisory")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_GET_GLOBAL_SECURITY_ADVISORY_USER_TITLE", "Get a global security advisory"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("ghsaId",
+ mcp.Description("GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx)."),
+ mcp.Required(),
+ ),
+ ), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ ghsaID, err := RequiredParam[string](request, "ghsaId")
+ if err != nil {
+ return mcp.NewToolResultError(fmt.Sprintf("invalid ghsaId: %v", err)), nil
+ }
+
+ advisory, resp, err := client.SecurityAdvisories.GetGlobalSecurityAdvisories(ctx, ghsaID)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get advisory: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to get advisory: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(advisory)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal advisory: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
+
+func ListOrgRepositorySecurityAdvisories(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+ return mcp.NewTool("list_org_repository_security_advisories",
+ mcp.WithDescription(t("TOOL_LIST_ORG_REPOSITORY_SECURITY_ADVISORIES_DESCRIPTION", "List repository security advisories for a GitHub organization.")),
+ mcp.WithToolAnnotation(mcp.ToolAnnotation{
+ Title: t("TOOL_LIST_ORG_REPOSITORY_SECURITY_ADVISORIES_USER_TITLE", "List org repository security advisories"),
+ ReadOnlyHint: ToBoolPtr(true),
+ }),
+ mcp.WithString("org",
+ mcp.Required(),
+ mcp.Description("The organization login."),
+ ),
+ mcp.WithString("direction",
+ mcp.Description("Sort direction."),
+ mcp.Enum("asc", "desc"),
+ ),
+ mcp.WithString("sort",
+ mcp.Description("Sort field."),
+ mcp.Enum("created", "updated", "published"),
+ ),
+ mcp.WithString("state",
+ mcp.Description("Filter by advisory state."),
+ mcp.Enum("triage", "draft", "published", "closed"),
+ ),
+ ), func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+ org, err := RequiredParam[string](request, "org")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ direction, err := OptionalParam[string](request, "direction")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ sortField, err := OptionalParam[string](request, "sort")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+ state, err := OptionalParam[string](request, "state")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
+
+ client, err := getClient(ctx)
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ opts := &github.ListRepositorySecurityAdvisoriesOptions{}
+ if direction != "" {
+ opts.Direction = direction
+ }
+ if sortField != "" {
+ opts.Sort = sortField
+ }
+ if state != "" {
+ opts.State = state
+ }
+
+ advisories, resp, err := client.SecurityAdvisories.ListRepositorySecurityAdvisoriesForOrg(ctx, org, opts)
+ if err != nil {
+ return nil, fmt.Errorf("failed to list organization repository security advisories: %w", err)
+ }
+ defer func() { _ = resp.Body.Close() }()
+
+ if resp.StatusCode != http.StatusOK {
+ body, err := io.ReadAll(resp.Body)
+ if err != nil {
+ return nil, fmt.Errorf("failed to read response body: %w", err)
+ }
+ return mcp.NewToolResultError(fmt.Sprintf("failed to list organization repository advisories: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(advisories)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal advisories: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
+}
diff --git a/pkg/github/security_advisories_test.go b/pkg/github/security_advisories_test.go
new file mode 100644
index 000000000..0640f917d
--- /dev/null
+++ b/pkg/github/security_advisories_test.go
@@ -0,0 +1,526 @@
+package github
+
+import (
+ "context"
+ "encoding/json"
+ "net/http"
+ "testing"
+
+ "github.com/github/github-mcp-server/pkg/translations"
+ "github.com/google/go-github/v74/github"
+ "github.com/migueleliasweb/go-github-mock/src/mock"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func Test_ListGlobalSecurityAdvisories(t *testing.T) {
+ mockClient := github.NewClient(nil)
+ tool, _ := ListGlobalSecurityAdvisories(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "list_global_security_advisories", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "ecosystem")
+ assert.Contains(t, tool.InputSchema.Properties, "severity")
+ assert.Contains(t, tool.InputSchema.Properties, "ghsaId")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{})
+
+ // Setup mock advisory for success case
+ mockAdvisory := &github.GlobalSecurityAdvisory{
+ SecurityAdvisory: github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-xxxx-xxxx-xxxx"),
+ Summary: github.Ptr("Test advisory"),
+ Description: github.Ptr("This is a test advisory."),
+ Severity: github.Ptr("high"),
+ },
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedAdvisories []*github.GlobalSecurityAdvisory
+ expectedErrMsg string
+ }{
+ {
+ name: "successful advisory fetch",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetAdvisories,
+ []*github.GlobalSecurityAdvisory{mockAdvisory},
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "type": "reviewed",
+ "ecosystem": "npm",
+ "severity": "high",
+ },
+ expectError: false,
+ expectedAdvisories: []*github.GlobalSecurityAdvisory{mockAdvisory},
+ },
+ {
+ name: "invalid severity value",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetAdvisories,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusBadRequest)
+ _, _ = w.Write([]byte(`{"message": "Bad Request"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "type": "reviewed",
+ "severity": "extreme",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to list global security advisories",
+ },
+ {
+ name: "API error handling",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetAdvisories,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusInternalServerError)
+ _, _ = w.Write([]byte(`{"message": "Internal Server Error"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{},
+ expectError: true,
+ expectedErrMsg: "failed to list global security advisories",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ // Setup client with mock
+ client := github.NewClient(tc.mockedClient)
+ _, handler := ListGlobalSecurityAdvisories(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ // Create call request
+ request := createMCPRequest(tc.requestArgs)
+
+ // Call handler
+ result, err := handler(context.Background(), request)
+
+ // Verify results
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+
+ // Parse the result and get the text content if no error
+ textContent := getTextResult(t, result)
+
+ // Unmarshal and verify the result
+ var returnedAdvisories []*github.GlobalSecurityAdvisory
+ err = json.Unmarshal([]byte(textContent.Text), &returnedAdvisories)
+ assert.NoError(t, err)
+ assert.Len(t, returnedAdvisories, len(tc.expectedAdvisories))
+ for i, advisory := range returnedAdvisories {
+ assert.Equal(t, *tc.expectedAdvisories[i].GHSAID, *advisory.GHSAID)
+ assert.Equal(t, *tc.expectedAdvisories[i].Summary, *advisory.Summary)
+ assert.Equal(t, *tc.expectedAdvisories[i].Description, *advisory.Description)
+ assert.Equal(t, *tc.expectedAdvisories[i].Severity, *advisory.Severity)
+ }
+ })
+ }
+}
+
+func Test_GetGlobalSecurityAdvisory(t *testing.T) {
+ mockClient := github.NewClient(nil)
+ tool, _ := GetGlobalSecurityAdvisory(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "get_global_security_advisory", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "ghsaId")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"ghsaId"})
+
+ // Setup mock advisory for success case
+ mockAdvisory := &github.GlobalSecurityAdvisory{
+ SecurityAdvisory: github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-xxxx-xxxx-xxxx"),
+ Summary: github.Ptr("Test advisory"),
+ Description: github.Ptr("This is a test advisory."),
+ Severity: github.Ptr("high"),
+ },
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedAdvisory *github.GlobalSecurityAdvisory
+ expectedErrMsg string
+ }{
+ {
+ name: "successful advisory fetch",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatch(
+ mock.GetAdvisoriesByGhsaId,
+ mockAdvisory,
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "ghsaId": "GHSA-xxxx-xxxx-xxxx",
+ },
+ expectError: false,
+ expectedAdvisory: mockAdvisory,
+ },
+ {
+ name: "invalid ghsaId format",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetAdvisoriesByGhsaId,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusBadRequest)
+ _, _ = w.Write([]byte(`{"message": "Bad Request"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "ghsaId": "invalid-ghsa-id",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to get advisory",
+ },
+ {
+ name: "advisory not found",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetAdvisoriesByGhsaId,
+ http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+ w.WriteHeader(http.StatusNotFound)
+ _, _ = w.Write([]byte(`{"message": "Not Found"}`))
+ }),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "ghsaId": "GHSA-xxxx-xxxx-xxxx",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to get advisory",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ // Setup client with mock
+ client := github.NewClient(tc.mockedClient)
+ _, handler := GetGlobalSecurityAdvisory(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ // Create call request
+ request := createMCPRequest(tc.requestArgs)
+
+ // Call handler
+ result, err := handler(context.Background(), request)
+
+ // Verify results
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+
+ // Parse the result and get the text content if no error
+ textContent := getTextResult(t, result)
+
+ // Verify the result
+ assert.Contains(t, textContent.Text, *tc.expectedAdvisory.GHSAID)
+ assert.Contains(t, textContent.Text, *tc.expectedAdvisory.Summary)
+ assert.Contains(t, textContent.Text, *tc.expectedAdvisory.Description)
+ assert.Contains(t, textContent.Text, *tc.expectedAdvisory.Severity)
+ })
+ }
+}
+
+func Test_ListRepositorySecurityAdvisories(t *testing.T) {
+ // Verify tool definition once
+ mockClient := github.NewClient(nil)
+ tool, _ := ListRepositorySecurityAdvisories(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "list_repository_security_advisories", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "owner")
+ assert.Contains(t, tool.InputSchema.Properties, "repo")
+ assert.Contains(t, tool.InputSchema.Properties, "direction")
+ assert.Contains(t, tool.InputSchema.Properties, "sort")
+ assert.Contains(t, tool.InputSchema.Properties, "state")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"owner", "repo"})
+
+ // Local endpoint pattern for repository security advisories
+ var GetReposSecurityAdvisoriesByOwnerByRepo = mock.EndpointPattern{
+ Pattern: "/repos/{owner}/{repo}/security-advisories",
+ Method: "GET",
+ }
+
+ // Setup mock advisories for success cases
+ adv1 := &github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-1111-1111-1111"),
+ Summary: github.Ptr("Repo advisory one"),
+ Description: github.Ptr("First repo advisory."),
+ Severity: github.Ptr("high"),
+ }
+ adv2 := &github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-2222-2222-2222"),
+ Summary: github.Ptr("Repo advisory two"),
+ Description: github.Ptr("Second repo advisory."),
+ Severity: github.Ptr("medium"),
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedAdvisories []*github.SecurityAdvisory
+ expectedErrMsg string
+ }{
+ {
+ name: "successful advisories listing (no filters)",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetReposSecurityAdvisoriesByOwnerByRepo,
+ expect(t, expectations{
+ path: "/repos/owner/repo/security-advisories",
+ queryParams: map[string]string{},
+ }).andThen(
+ mockResponse(t, http.StatusOK, []*github.SecurityAdvisory{adv1, adv2}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: false,
+ expectedAdvisories: []*github.SecurityAdvisory{adv1, adv2},
+ },
+ {
+ name: "successful advisories listing with filters",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetReposSecurityAdvisoriesByOwnerByRepo,
+ expect(t, expectations{
+ path: "/repos/octo/hello-world/security-advisories",
+ queryParams: map[string]string{
+ "direction": "desc",
+ "sort": "updated",
+ "state": "published",
+ },
+ }).andThen(
+ mockResponse(t, http.StatusOK, []*github.SecurityAdvisory{adv1}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "octo",
+ "repo": "hello-world",
+ "direction": "desc",
+ "sort": "updated",
+ "state": "published",
+ },
+ expectError: false,
+ expectedAdvisories: []*github.SecurityAdvisory{adv1},
+ },
+ {
+ name: "advisories listing fails",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetReposSecurityAdvisoriesByOwnerByRepo,
+ expect(t, expectations{
+ path: "/repos/owner/repo/security-advisories",
+ queryParams: map[string]string{},
+ }).andThen(
+ mockResponse(t, http.StatusInternalServerError, map[string]string{"message": "Internal Server Error"}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "owner": "owner",
+ "repo": "repo",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to list repository security advisories",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ client := github.NewClient(tc.mockedClient)
+ _, handler := ListRepositorySecurityAdvisories(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ request := createMCPRequest(tc.requestArgs)
+
+ result, err := handler(context.Background(), request)
+
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+
+ textContent := getTextResult(t, result)
+
+ var returnedAdvisories []*github.SecurityAdvisory
+ err = json.Unmarshal([]byte(textContent.Text), &returnedAdvisories)
+ assert.NoError(t, err)
+ assert.Len(t, returnedAdvisories, len(tc.expectedAdvisories))
+ for i, advisory := range returnedAdvisories {
+ assert.Equal(t, *tc.expectedAdvisories[i].GHSAID, *advisory.GHSAID)
+ assert.Equal(t, *tc.expectedAdvisories[i].Summary, *advisory.Summary)
+ assert.Equal(t, *tc.expectedAdvisories[i].Description, *advisory.Description)
+ assert.Equal(t, *tc.expectedAdvisories[i].Severity, *advisory.Severity)
+ }
+ })
+ }
+}
+
+func Test_ListOrgRepositorySecurityAdvisories(t *testing.T) {
+ // Verify tool definition once
+ mockClient := github.NewClient(nil)
+ tool, _ := ListOrgRepositorySecurityAdvisories(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+
+ assert.Equal(t, "list_org_repository_security_advisories", tool.Name)
+ assert.NotEmpty(t, tool.Description)
+ assert.Contains(t, tool.InputSchema.Properties, "org")
+ assert.Contains(t, tool.InputSchema.Properties, "direction")
+ assert.Contains(t, tool.InputSchema.Properties, "sort")
+ assert.Contains(t, tool.InputSchema.Properties, "state")
+ assert.ElementsMatch(t, tool.InputSchema.Required, []string{"org"})
+
+ // Endpoint pattern for org repository security advisories
+ var GetOrgsSecurityAdvisoriesByOrg = mock.EndpointPattern{
+ Pattern: "/orgs/{org}/security-advisories",
+ Method: "GET",
+ }
+
+ adv1 := &github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-aaaa-bbbb-cccc"),
+ Summary: github.Ptr("Org repo advisory 1"),
+ Description: github.Ptr("First advisory"),
+ Severity: github.Ptr("low"),
+ }
+ adv2 := &github.SecurityAdvisory{
+ GHSAID: github.Ptr("GHSA-dddd-eeee-ffff"),
+ Summary: github.Ptr("Org repo advisory 2"),
+ Description: github.Ptr("Second advisory"),
+ Severity: github.Ptr("critical"),
+ }
+
+ tests := []struct {
+ name string
+ mockedClient *http.Client
+ requestArgs map[string]interface{}
+ expectError bool
+ expectedAdvisories []*github.SecurityAdvisory
+ expectedErrMsg string
+ }{
+ {
+ name: "successful listing (no filters)",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetOrgsSecurityAdvisoriesByOrg,
+ expect(t, expectations{
+ path: "/orgs/octo/security-advisories",
+ queryParams: map[string]string{},
+ }).andThen(
+ mockResponse(t, http.StatusOK, []*github.SecurityAdvisory{adv1, adv2}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "org": "octo",
+ },
+ expectError: false,
+ expectedAdvisories: []*github.SecurityAdvisory{adv1, adv2},
+ },
+ {
+ name: "successful listing with filters",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetOrgsSecurityAdvisoriesByOrg,
+ expect(t, expectations{
+ path: "/orgs/octo/security-advisories",
+ queryParams: map[string]string{
+ "direction": "asc",
+ "sort": "created",
+ "state": "triage",
+ },
+ }).andThen(
+ mockResponse(t, http.StatusOK, []*github.SecurityAdvisory{adv1}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "org": "octo",
+ "direction": "asc",
+ "sort": "created",
+ "state": "triage",
+ },
+ expectError: false,
+ expectedAdvisories: []*github.SecurityAdvisory{adv1},
+ },
+ {
+ name: "listing fails",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ GetOrgsSecurityAdvisoriesByOrg,
+ expect(t, expectations{
+ path: "/orgs/octo/security-advisories",
+ queryParams: map[string]string{},
+ }).andThen(
+ mockResponse(t, http.StatusForbidden, map[string]string{"message": "Forbidden"}),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "org": "octo",
+ },
+ expectError: true,
+ expectedErrMsg: "failed to list organization repository security advisories",
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ client := github.NewClient(tc.mockedClient)
+ _, handler := ListOrgRepositorySecurityAdvisories(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ request := createMCPRequest(tc.requestArgs)
+
+ result, err := handler(context.Background(), request)
+
+ if tc.expectError {
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), tc.expectedErrMsg)
+ return
+ }
+
+ require.NoError(t, err)
+
+ textContent := getTextResult(t, result)
+
+ var returnedAdvisories []*github.SecurityAdvisory
+ err = json.Unmarshal([]byte(textContent.Text), &returnedAdvisories)
+ assert.NoError(t, err)
+ assert.Len(t, returnedAdvisories, len(tc.expectedAdvisories))
+ for i, advisory := range returnedAdvisories {
+ assert.Equal(t, *tc.expectedAdvisories[i].GHSAID, *advisory.GHSAID)
+ assert.Equal(t, *tc.expectedAdvisories[i].Summary, *advisory.Summary)
+ assert.Equal(t, *tc.expectedAdvisories[i].Description, *advisory.Description)
+ assert.Equal(t, *tc.expectedAdvisories[i].Severity, *advisory.Severity)
+ }
+ })
+ }
+}
diff --git a/pkg/github/tools.go b/pkg/github/tools.go
index b41ba9467..728d78097 100644
--- a/pkg/github/tools.go
+++ b/pkg/github/tools.go
@@ -16,7 +16,7 @@ type GetGQLClientFn func(context.Context) (*githubv4.Client, error)
var DefaultTools = []string{"all"}
-func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetGQLClientFn, getRawClient raw.GetRawClientFn, t translations.TranslationHelperFunc) *toolsets.ToolsetGroup {
+func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetGQLClientFn, getRawClient raw.GetRawClientFn, t translations.TranslationHelperFunc, contentWindowSize int) *toolsets.ToolsetGroup {
tsg := toolsets.NewToolsetGroup(readOnly)
// Define all available features with their default state (disabled)
@@ -31,6 +31,9 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
toolsets.NewServerTool(ListBranches(getClient, t)),
toolsets.NewServerTool(ListTags(getClient, t)),
toolsets.NewServerTool(GetTag(getClient, t)),
+ toolsets.NewServerTool(ListReleases(getClient, t)),
+ toolsets.NewServerTool(GetLatestRelease(getClient, t)),
+ toolsets.NewServerTool(GetReleaseByTag(getClient, t)),
).
AddWriteTools(
toolsets.NewServerTool(CreateOrUpdateFile(getClient, t)),
@@ -53,6 +56,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
toolsets.NewServerTool(SearchIssues(getClient, t)),
toolsets.NewServerTool(ListIssues(getGQLClient, t)),
toolsets.NewServerTool(GetIssueComments(getClient, t)),
+ toolsets.NewServerTool(ListIssueTypes(getClient, t)),
toolsets.NewServerTool(ListSubIssues(getClient, t)),
).
AddWriteTools(
@@ -143,7 +147,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
toolsets.NewServerTool(GetWorkflowRun(getClient, t)),
toolsets.NewServerTool(GetWorkflowRunLogs(getClient, t)),
toolsets.NewServerTool(ListWorkflowJobs(getClient, t)),
- toolsets.NewServerTool(GetJobLogs(getClient, t)),
+ toolsets.NewServerTool(GetJobLogs(getClient, t, contentWindowSize)),
toolsets.NewServerTool(ListWorkflowRunArtifacts(getClient, t)),
toolsets.NewServerTool(DownloadWorkflowRunArtifact(getClient, t)),
toolsets.NewServerTool(GetWorkflowRunUsage(getClient, t)),
@@ -156,12 +160,22 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
toolsets.NewServerTool(DeleteWorkflowRunLogs(getClient, t)),
)
+ securityAdvisories := toolsets.NewToolset("security_advisories", "Security advisories related tools").
+ AddReadTools(
+ toolsets.NewServerTool(ListGlobalSecurityAdvisories(getClient, t)),
+ toolsets.NewServerTool(GetGlobalSecurityAdvisory(getClient, t)),
+ toolsets.NewServerTool(ListRepositorySecurityAdvisories(getClient, t)),
+ toolsets.NewServerTool(ListOrgRepositorySecurityAdvisories(getClient, t)),
+ )
+
// Keep experiments alive so the system doesn't error out when it's always enabled
experiments := toolsets.NewToolset("experiments", "Experimental features that are not considered stable yet")
contextTools := toolsets.NewToolset("context", "Tools that provide context about the current user and GitHub context you are operating in").
AddReadTools(
toolsets.NewServerTool(GetMe(getClient, t)),
+ toolsets.NewServerTool(GetTeams(getClient, getGQLClient, t)),
+ toolsets.NewServerTool(GetTeamMembers(getGQLClient, t)),
)
gists := toolsets.NewToolset("gists", "GitHub Gist related tools").
@@ -188,6 +202,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
tsg.AddToolset(experiments)
tsg.AddToolset(discussions)
tsg.AddToolset(gists)
+ tsg.AddToolset(securityAdvisories)
return tsg
}
diff --git a/pkg/github/workflow_prompts.go b/pkg/github/workflow_prompts.go
index 8a9545a42..42b6d51c8 100644
--- a/pkg/github/workflow_prompts.go
+++ b/pkg/github/workflow_prompts.go
@@ -37,7 +37,7 @@ func IssueToFixWorkflowPrompt(t translations.TranslationHelperFunc) (tool mcp.Pr
messages := []mcp.PromptMessage{
{
- Role: "system",
+ Role: "user",
Content: mcp.NewTextContent("You are a development workflow assistant helping to create GitHub issues and generate corresponding pull requests to fix them. You should: 1) Create a well-structured issue with clear problem description, 2) Assign it to Copilot coding agent to generate a solution, and 3) Monitor the PR creation process."),
},
{
diff --git a/pkg/log/io.go b/pkg/log/io.go
index de2210278..44b8dc17a 100644
--- a/pkg/log/io.go
+++ b/pkg/log/io.go
@@ -3,7 +3,7 @@ package log
import (
"io"
- log "github.com/sirupsen/logrus"
+ "log/slog"
)
// IOLogger is a wrapper around io.Reader and io.Writer that can be used
@@ -11,11 +11,11 @@ import (
type IOLogger struct {
reader io.Reader
writer io.Writer
- logger *log.Logger
+ logger *slog.Logger
}
// NewIOLogger creates a new IOLogger instance
-func NewIOLogger(r io.Reader, w io.Writer, logger *log.Logger) *IOLogger {
+func NewIOLogger(r io.Reader, w io.Writer, logger *slog.Logger) *IOLogger {
return &IOLogger{
reader: r,
writer: w,
@@ -30,7 +30,7 @@ func (l *IOLogger) Read(p []byte) (n int, err error) {
}
n, err = l.reader.Read(p)
if n > 0 {
- l.logger.Infof("[stdin]: received %d bytes: %s", n, string(p[:n]))
+ l.logger.Info("[stdin]: received bytes", "count", n, "data", string(p[:n]))
}
return n, err
}
@@ -40,6 +40,6 @@ func (l *IOLogger) Write(p []byte) (n int, err error) {
if l.writer == nil {
return 0, io.ErrClosedPipe
}
- l.logger.Infof("[stdout]: sending %d bytes: %s", len(p), string(p))
+ l.logger.Info("[stdout]: sending bytes", "count", len(p), "data", string(p))
return l.writer.Write(p)
}
diff --git a/pkg/log/io_test.go b/pkg/log/io_test.go
index 0d0cd8959..2661de164 100644
--- a/pkg/log/io_test.go
+++ b/pkg/log/io_test.go
@@ -5,7 +5,8 @@ import (
"strings"
"testing"
- log "github.com/sirupsen/logrus"
+ "log/slog"
+
"github.com/stretchr/testify/assert"
)
@@ -17,11 +18,7 @@ func TestLoggedReadWriter(t *testing.T) {
// Create logger with buffer to capture output
var logBuffer bytes.Buffer
- logger := log.New()
- logger.SetOutput(&logBuffer)
- logger.SetFormatter(&log.TextFormatter{
- DisableTimestamp: true,
- })
+ logger := slog.New(slog.NewTextHandler(&logBuffer, &slog.HandlerOptions{ReplaceAttr: removeTimeAttr}))
lrw := NewIOLogger(reader, nil, logger)
@@ -44,11 +41,7 @@ func TestLoggedReadWriter(t *testing.T) {
// Create logger with buffer to capture output
var logBuffer bytes.Buffer
- logger := log.New()
- logger.SetOutput(&logBuffer)
- logger.SetFormatter(&log.TextFormatter{
- DisableTimestamp: true,
- })
+ logger := slog.New(slog.NewTextHandler(&logBuffer, &slog.HandlerOptions{ReplaceAttr: removeTimeAttr}))
lrw := NewIOLogger(nil, &writeBuffer, logger)
@@ -63,3 +56,10 @@ func TestLoggedReadWriter(t *testing.T) {
assert.Contains(t, logBuffer.String(), outputData)
})
}
+
+func removeTimeAttr(groups []string, a slog.Attr) slog.Attr {
+ if a.Key == slog.TimeKey && len(groups) == 0 {
+ return slog.Attr{}
+ }
+ return a
+}
diff --git a/pkg/toolsets/toolsets.go b/pkg/toolsets/toolsets.go
index 5d503b742..85cd5d841 100644
--- a/pkg/toolsets/toolsets.go
+++ b/pkg/toolsets/toolsets.go
@@ -33,32 +33,20 @@ func NewServerTool(tool mcp.Tool, handler server.ToolHandlerFunc) server.ServerT
return server.ServerTool{Tool: tool, Handler: handler}
}
-func NewServerResourceTemplate(resourceTemplate mcp.ResourceTemplate, handler server.ResourceTemplateHandlerFunc) ServerResourceTemplate {
- return ServerResourceTemplate{
- resourceTemplate: resourceTemplate,
- handler: handler,
+func NewServerResourceTemplate(resourceTemplate mcp.ResourceTemplate, handler server.ResourceTemplateHandlerFunc) server.ServerResourceTemplate {
+ return server.ServerResourceTemplate{
+ Template: resourceTemplate,
+ Handler: handler,
}
}
-func NewServerPrompt(prompt mcp.Prompt, handler server.PromptHandlerFunc) ServerPrompt {
- return ServerPrompt{
+func NewServerPrompt(prompt mcp.Prompt, handler server.PromptHandlerFunc) server.ServerPrompt {
+ return server.ServerPrompt{
Prompt: prompt,
Handler: handler,
}
}
-// ServerResourceTemplate represents a resource template that can be registered with the MCP server.
-type ServerResourceTemplate struct {
- resourceTemplate mcp.ResourceTemplate
- handler server.ResourceTemplateHandlerFunc
-}
-
-// ServerPrompt represents a prompt that can be registered with the MCP server.
-type ServerPrompt struct {
- Prompt mcp.Prompt
- Handler server.PromptHandlerFunc
-}
-
// Toolset represents a collection of MCP functionality that can be enabled or disabled as a group.
type Toolset struct {
Name string
@@ -69,9 +57,9 @@ type Toolset struct {
readTools []server.ServerTool
// resources are not tools, but the community seems to be moving towards namespaces as a broader concept
// and in order to have multiple servers running concurrently, we want to avoid overlapping resources too.
- resourceTemplates []ServerResourceTemplate
+ resourceTemplates []server.ServerResourceTemplate
// prompts are also not tools but are namespaced similarly
- prompts []ServerPrompt
+ prompts []server.ServerPrompt
}
func (t *Toolset) GetActiveTools() []server.ServerTool {
@@ -105,24 +93,24 @@ func (t *Toolset) RegisterTools(s *server.MCPServer) {
}
}
-func (t *Toolset) AddResourceTemplates(templates ...ServerResourceTemplate) *Toolset {
+func (t *Toolset) AddResourceTemplates(templates ...server.ServerResourceTemplate) *Toolset {
t.resourceTemplates = append(t.resourceTemplates, templates...)
return t
}
-func (t *Toolset) AddPrompts(prompts ...ServerPrompt) *Toolset {
+func (t *Toolset) AddPrompts(prompts ...server.ServerPrompt) *Toolset {
t.prompts = append(t.prompts, prompts...)
return t
}
-func (t *Toolset) GetActiveResourceTemplates() []ServerResourceTemplate {
+func (t *Toolset) GetActiveResourceTemplates() []server.ServerResourceTemplate {
if !t.Enabled {
return nil
}
return t.resourceTemplates
}
-func (t *Toolset) GetAvailableResourceTemplates() []ServerResourceTemplate {
+func (t *Toolset) GetAvailableResourceTemplates() []server.ServerResourceTemplate {
return t.resourceTemplates
}
@@ -131,7 +119,7 @@ func (t *Toolset) RegisterResourcesTemplates(s *server.MCPServer) {
return
}
for _, resource := range t.resourceTemplates {
- s.AddResourceTemplate(resource.resourceTemplate, resource.handler)
+ s.AddResourceTemplate(resource.Template, resource.Handler)
}
}
diff --git a/third-party-licenses.darwin.md b/third-party-licenses.darwin.md
index 2f6c0ecb8..c279f72ea 100644
--- a/third-party-licenses.darwin.md
+++ b/third-party-licenses.darwin.md
@@ -7,6 +7,8 @@ The following open source dependencies are used to build the [github/github-mcp-
Some packages may only be included on certain architectures or operating systems.
+ - [github.com/bahlo/generic-list-go](https://pkg.go.dev/github.com/bahlo/generic-list-go) ([BSD-3-Clause](https://github.com/bahlo/generic-list-go/blob/v0.2.0/LICENSE))
+ - [github.com/buger/jsonparser](https://pkg.go.dev/github.com/buger/jsonparser) ([MIT](https://github.com/buger/jsonparser/blob/v1.1.1/LICENSE))
- [github.com/fsnotify/fsnotify](https://pkg.go.dev/github.com/fsnotify/fsnotify) ([BSD-3-Clause](https://github.com/fsnotify/fsnotify/blob/v1.8.0/LICENSE))
- [github.com/github/github-mcp-server](https://pkg.go.dev/github.com/github/github-mcp-server) ([MIT](https://github.com/github/github-mcp-server/blob/HEAD/LICENSE))
- [github.com/go-openapi/jsonpointer](https://pkg.go.dev/github.com/go-openapi/jsonpointer) ([Apache-2.0](https://github.com/go-openapi/jsonpointer/blob/v0.19.5/LICENSE))
@@ -17,16 +19,16 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/google/go-querystring/query](https://pkg.go.dev/github.com/google/go-querystring/query) ([BSD-3-Clause](https://github.com/google/go-querystring/blob/v1.1.0/LICENSE))
- [github.com/google/uuid](https://pkg.go.dev/github.com/google/uuid) ([BSD-3-Clause](https://github.com/google/uuid/blob/v1.6.0/LICENSE))
- [github.com/gorilla/mux](https://pkg.go.dev/github.com/gorilla/mux) ([BSD-3-Clause](https://github.com/gorilla/mux/blob/v1.8.0/LICENSE))
+ - [github.com/invopop/jsonschema](https://pkg.go.dev/github.com/invopop/jsonschema) ([MIT](https://github.com/invopop/jsonschema/blob/v0.13.0/COPYING))
- [github.com/josephburnett/jd/v2](https://pkg.go.dev/github.com/josephburnett/jd/v2) ([MIT](https://github.com/josephburnett/jd/blob/v1.9.2/LICENSE))
- [github.com/josharian/intern](https://pkg.go.dev/github.com/josharian/intern) ([MIT](https://github.com/josharian/intern/blob/v1.0.0/license.md))
- [github.com/mailru/easyjson](https://pkg.go.dev/github.com/mailru/easyjson) ([MIT](https://github.com/mailru/easyjson/blob/v0.7.7/LICENSE))
- - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.32.0/LICENSE))
+ - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.36.0/LICENSE))
- [github.com/migueleliasweb/go-github-mock/src/mock](https://pkg.go.dev/github.com/migueleliasweb/go-github-mock/src/mock) ([MIT](https://github.com/migueleliasweb/go-github-mock/blob/v1.3.0/LICENSE))
- [github.com/pelletier/go-toml/v2](https://pkg.go.dev/github.com/pelletier/go-toml/v2) ([MIT](https://github.com/pelletier/go-toml/blob/v2.2.3/LICENSE))
- [github.com/sagikazarmark/locafero](https://pkg.go.dev/github.com/sagikazarmark/locafero) ([MIT](https://github.com/sagikazarmark/locafero/blob/v0.9.0/LICENSE))
- [github.com/shurcooL/githubv4](https://pkg.go.dev/github.com/shurcooL/githubv4) ([MIT](https://github.com/shurcooL/githubv4/blob/48295856cce7/LICENSE))
- [github.com/shurcooL/graphql](https://pkg.go.dev/github.com/shurcooL/graphql) ([MIT](https://github.com/shurcooL/graphql/blob/ed46e5a46466/LICENSE))
- - [github.com/sirupsen/logrus](https://pkg.go.dev/github.com/sirupsen/logrus) ([MIT](https://github.com/sirupsen/logrus/blob/v1.9.3/LICENSE))
- [github.com/sourcegraph/conc](https://pkg.go.dev/github.com/sourcegraph/conc) ([MIT](https://github.com/sourcegraph/conc/blob/v0.3.0/LICENSE))
- [github.com/spf13/afero](https://pkg.go.dev/github.com/spf13/afero) ([Apache-2.0](https://github.com/spf13/afero/blob/v1.14.0/LICENSE.txt))
- [github.com/spf13/cast](https://pkg.go.dev/github.com/spf13/cast) ([MIT](https://github.com/spf13/cast/blob/v1.7.1/LICENSE))
@@ -34,6 +36,7 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/spf13/pflag](https://pkg.go.dev/github.com/spf13/pflag) ([BSD-3-Clause](https://github.com/spf13/pflag/blob/v1.0.6/LICENSE))
- [github.com/spf13/viper](https://pkg.go.dev/github.com/spf13/viper) ([MIT](https://github.com/spf13/viper/blob/v1.20.1/LICENSE))
- [github.com/subosito/gotenv](https://pkg.go.dev/github.com/subosito/gotenv) ([MIT](https://github.com/subosito/gotenv/blob/v1.6.0/LICENSE))
+ - [github.com/wk8/go-ordered-map/v2](https://pkg.go.dev/github.com/wk8/go-ordered-map/v2) ([Apache-2.0](https://github.com/wk8/go-ordered-map/blob/v2.1.8/LICENSE))
- [github.com/yosida95/uritemplate/v3](https://pkg.go.dev/github.com/yosida95/uritemplate/v3) ([BSD-3-Clause](https://github.com/yosida95/uritemplate/blob/v3.0.2/LICENSE))
- [github.com/yudai/golcs](https://pkg.go.dev/github.com/yudai/golcs) ([MIT](https://github.com/yudai/golcs/blob/ecda9a501e82/LICENSE))
- [golang.org/x/exp](https://pkg.go.dev/golang.org/x/exp) ([BSD-3-Clause](https://cs.opensource.google/go/x/exp/+/8a7402ab:LICENSE))
diff --git a/third-party-licenses.linux.md b/third-party-licenses.linux.md
index 2f6c0ecb8..c279f72ea 100644
--- a/third-party-licenses.linux.md
+++ b/third-party-licenses.linux.md
@@ -7,6 +7,8 @@ The following open source dependencies are used to build the [github/github-mcp-
Some packages may only be included on certain architectures or operating systems.
+ - [github.com/bahlo/generic-list-go](https://pkg.go.dev/github.com/bahlo/generic-list-go) ([BSD-3-Clause](https://github.com/bahlo/generic-list-go/blob/v0.2.0/LICENSE))
+ - [github.com/buger/jsonparser](https://pkg.go.dev/github.com/buger/jsonparser) ([MIT](https://github.com/buger/jsonparser/blob/v1.1.1/LICENSE))
- [github.com/fsnotify/fsnotify](https://pkg.go.dev/github.com/fsnotify/fsnotify) ([BSD-3-Clause](https://github.com/fsnotify/fsnotify/blob/v1.8.0/LICENSE))
- [github.com/github/github-mcp-server](https://pkg.go.dev/github.com/github/github-mcp-server) ([MIT](https://github.com/github/github-mcp-server/blob/HEAD/LICENSE))
- [github.com/go-openapi/jsonpointer](https://pkg.go.dev/github.com/go-openapi/jsonpointer) ([Apache-2.0](https://github.com/go-openapi/jsonpointer/blob/v0.19.5/LICENSE))
@@ -17,16 +19,16 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/google/go-querystring/query](https://pkg.go.dev/github.com/google/go-querystring/query) ([BSD-3-Clause](https://github.com/google/go-querystring/blob/v1.1.0/LICENSE))
- [github.com/google/uuid](https://pkg.go.dev/github.com/google/uuid) ([BSD-3-Clause](https://github.com/google/uuid/blob/v1.6.0/LICENSE))
- [github.com/gorilla/mux](https://pkg.go.dev/github.com/gorilla/mux) ([BSD-3-Clause](https://github.com/gorilla/mux/blob/v1.8.0/LICENSE))
+ - [github.com/invopop/jsonschema](https://pkg.go.dev/github.com/invopop/jsonschema) ([MIT](https://github.com/invopop/jsonschema/blob/v0.13.0/COPYING))
- [github.com/josephburnett/jd/v2](https://pkg.go.dev/github.com/josephburnett/jd/v2) ([MIT](https://github.com/josephburnett/jd/blob/v1.9.2/LICENSE))
- [github.com/josharian/intern](https://pkg.go.dev/github.com/josharian/intern) ([MIT](https://github.com/josharian/intern/blob/v1.0.0/license.md))
- [github.com/mailru/easyjson](https://pkg.go.dev/github.com/mailru/easyjson) ([MIT](https://github.com/mailru/easyjson/blob/v0.7.7/LICENSE))
- - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.32.0/LICENSE))
+ - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.36.0/LICENSE))
- [github.com/migueleliasweb/go-github-mock/src/mock](https://pkg.go.dev/github.com/migueleliasweb/go-github-mock/src/mock) ([MIT](https://github.com/migueleliasweb/go-github-mock/blob/v1.3.0/LICENSE))
- [github.com/pelletier/go-toml/v2](https://pkg.go.dev/github.com/pelletier/go-toml/v2) ([MIT](https://github.com/pelletier/go-toml/blob/v2.2.3/LICENSE))
- [github.com/sagikazarmark/locafero](https://pkg.go.dev/github.com/sagikazarmark/locafero) ([MIT](https://github.com/sagikazarmark/locafero/blob/v0.9.0/LICENSE))
- [github.com/shurcooL/githubv4](https://pkg.go.dev/github.com/shurcooL/githubv4) ([MIT](https://github.com/shurcooL/githubv4/blob/48295856cce7/LICENSE))
- [github.com/shurcooL/graphql](https://pkg.go.dev/github.com/shurcooL/graphql) ([MIT](https://github.com/shurcooL/graphql/blob/ed46e5a46466/LICENSE))
- - [github.com/sirupsen/logrus](https://pkg.go.dev/github.com/sirupsen/logrus) ([MIT](https://github.com/sirupsen/logrus/blob/v1.9.3/LICENSE))
- [github.com/sourcegraph/conc](https://pkg.go.dev/github.com/sourcegraph/conc) ([MIT](https://github.com/sourcegraph/conc/blob/v0.3.0/LICENSE))
- [github.com/spf13/afero](https://pkg.go.dev/github.com/spf13/afero) ([Apache-2.0](https://github.com/spf13/afero/blob/v1.14.0/LICENSE.txt))
- [github.com/spf13/cast](https://pkg.go.dev/github.com/spf13/cast) ([MIT](https://github.com/spf13/cast/blob/v1.7.1/LICENSE))
@@ -34,6 +36,7 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/spf13/pflag](https://pkg.go.dev/github.com/spf13/pflag) ([BSD-3-Clause](https://github.com/spf13/pflag/blob/v1.0.6/LICENSE))
- [github.com/spf13/viper](https://pkg.go.dev/github.com/spf13/viper) ([MIT](https://github.com/spf13/viper/blob/v1.20.1/LICENSE))
- [github.com/subosito/gotenv](https://pkg.go.dev/github.com/subosito/gotenv) ([MIT](https://github.com/subosito/gotenv/blob/v1.6.0/LICENSE))
+ - [github.com/wk8/go-ordered-map/v2](https://pkg.go.dev/github.com/wk8/go-ordered-map/v2) ([Apache-2.0](https://github.com/wk8/go-ordered-map/blob/v2.1.8/LICENSE))
- [github.com/yosida95/uritemplate/v3](https://pkg.go.dev/github.com/yosida95/uritemplate/v3) ([BSD-3-Clause](https://github.com/yosida95/uritemplate/blob/v3.0.2/LICENSE))
- [github.com/yudai/golcs](https://pkg.go.dev/github.com/yudai/golcs) ([MIT](https://github.com/yudai/golcs/blob/ecda9a501e82/LICENSE))
- [golang.org/x/exp](https://pkg.go.dev/golang.org/x/exp) ([BSD-3-Clause](https://cs.opensource.google/go/x/exp/+/8a7402ab:LICENSE))
diff --git a/third-party-licenses.windows.md b/third-party-licenses.windows.md
index 63bf0cb69..531031dd8 100644
--- a/third-party-licenses.windows.md
+++ b/third-party-licenses.windows.md
@@ -7,6 +7,8 @@ The following open source dependencies are used to build the [github/github-mcp-
Some packages may only be included on certain architectures or operating systems.
+ - [github.com/bahlo/generic-list-go](https://pkg.go.dev/github.com/bahlo/generic-list-go) ([BSD-3-Clause](https://github.com/bahlo/generic-list-go/blob/v0.2.0/LICENSE))
+ - [github.com/buger/jsonparser](https://pkg.go.dev/github.com/buger/jsonparser) ([MIT](https://github.com/buger/jsonparser/blob/v1.1.1/LICENSE))
- [github.com/fsnotify/fsnotify](https://pkg.go.dev/github.com/fsnotify/fsnotify) ([BSD-3-Clause](https://github.com/fsnotify/fsnotify/blob/v1.8.0/LICENSE))
- [github.com/github/github-mcp-server](https://pkg.go.dev/github.com/github/github-mcp-server) ([MIT](https://github.com/github/github-mcp-server/blob/HEAD/LICENSE))
- [github.com/go-openapi/jsonpointer](https://pkg.go.dev/github.com/go-openapi/jsonpointer) ([Apache-2.0](https://github.com/go-openapi/jsonpointer/blob/v0.19.5/LICENSE))
@@ -18,16 +20,16 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/google/uuid](https://pkg.go.dev/github.com/google/uuid) ([BSD-3-Clause](https://github.com/google/uuid/blob/v1.6.0/LICENSE))
- [github.com/gorilla/mux](https://pkg.go.dev/github.com/gorilla/mux) ([BSD-3-Clause](https://github.com/gorilla/mux/blob/v1.8.0/LICENSE))
- [github.com/inconshreveable/mousetrap](https://pkg.go.dev/github.com/inconshreveable/mousetrap) ([Apache-2.0](https://github.com/inconshreveable/mousetrap/blob/v1.1.0/LICENSE))
+ - [github.com/invopop/jsonschema](https://pkg.go.dev/github.com/invopop/jsonschema) ([MIT](https://github.com/invopop/jsonschema/blob/v0.13.0/COPYING))
- [github.com/josephburnett/jd/v2](https://pkg.go.dev/github.com/josephburnett/jd/v2) ([MIT](https://github.com/josephburnett/jd/blob/v1.9.2/LICENSE))
- [github.com/josharian/intern](https://pkg.go.dev/github.com/josharian/intern) ([MIT](https://github.com/josharian/intern/blob/v1.0.0/license.md))
- [github.com/mailru/easyjson](https://pkg.go.dev/github.com/mailru/easyjson) ([MIT](https://github.com/mailru/easyjson/blob/v0.7.7/LICENSE))
- - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.32.0/LICENSE))
+ - [github.com/mark3labs/mcp-go](https://pkg.go.dev/github.com/mark3labs/mcp-go) ([MIT](https://github.com/mark3labs/mcp-go/blob/v0.36.0/LICENSE))
- [github.com/migueleliasweb/go-github-mock/src/mock](https://pkg.go.dev/github.com/migueleliasweb/go-github-mock/src/mock) ([MIT](https://github.com/migueleliasweb/go-github-mock/blob/v1.3.0/LICENSE))
- [github.com/pelletier/go-toml/v2](https://pkg.go.dev/github.com/pelletier/go-toml/v2) ([MIT](https://github.com/pelletier/go-toml/blob/v2.2.3/LICENSE))
- [github.com/sagikazarmark/locafero](https://pkg.go.dev/github.com/sagikazarmark/locafero) ([MIT](https://github.com/sagikazarmark/locafero/blob/v0.9.0/LICENSE))
- [github.com/shurcooL/githubv4](https://pkg.go.dev/github.com/shurcooL/githubv4) ([MIT](https://github.com/shurcooL/githubv4/blob/48295856cce7/LICENSE))
- [github.com/shurcooL/graphql](https://pkg.go.dev/github.com/shurcooL/graphql) ([MIT](https://github.com/shurcooL/graphql/blob/ed46e5a46466/LICENSE))
- - [github.com/sirupsen/logrus](https://pkg.go.dev/github.com/sirupsen/logrus) ([MIT](https://github.com/sirupsen/logrus/blob/v1.9.3/LICENSE))
- [github.com/sourcegraph/conc](https://pkg.go.dev/github.com/sourcegraph/conc) ([MIT](https://github.com/sourcegraph/conc/blob/v0.3.0/LICENSE))
- [github.com/spf13/afero](https://pkg.go.dev/github.com/spf13/afero) ([Apache-2.0](https://github.com/spf13/afero/blob/v1.14.0/LICENSE.txt))
- [github.com/spf13/cast](https://pkg.go.dev/github.com/spf13/cast) ([MIT](https://github.com/spf13/cast/blob/v1.7.1/LICENSE))
@@ -35,6 +37,7 @@ Some packages may only be included on certain architectures or operating systems
- [github.com/spf13/pflag](https://pkg.go.dev/github.com/spf13/pflag) ([BSD-3-Clause](https://github.com/spf13/pflag/blob/v1.0.6/LICENSE))
- [github.com/spf13/viper](https://pkg.go.dev/github.com/spf13/viper) ([MIT](https://github.com/spf13/viper/blob/v1.20.1/LICENSE))
- [github.com/subosito/gotenv](https://pkg.go.dev/github.com/subosito/gotenv) ([MIT](https://github.com/subosito/gotenv/blob/v1.6.0/LICENSE))
+ - [github.com/wk8/go-ordered-map/v2](https://pkg.go.dev/github.com/wk8/go-ordered-map/v2) ([Apache-2.0](https://github.com/wk8/go-ordered-map/blob/v2.1.8/LICENSE))
- [github.com/yosida95/uritemplate/v3](https://pkg.go.dev/github.com/yosida95/uritemplate/v3) ([BSD-3-Clause](https://github.com/yosida95/uritemplate/blob/v3.0.2/LICENSE))
- [github.com/yudai/golcs](https://pkg.go.dev/github.com/yudai/golcs) ([MIT](https://github.com/yudai/golcs/blob/ecda9a501e82/LICENSE))
- [golang.org/x/exp](https://pkg.go.dev/golang.org/x/exp) ([BSD-3-Clause](https://cs.opensource.google/go/x/exp/+/8a7402ab:LICENSE))
diff --git a/third-party/github.com/bahlo/generic-list-go/LICENSE b/third-party/github.com/bahlo/generic-list-go/LICENSE
new file mode 100644
index 000000000..6a66aea5e
--- /dev/null
+++ b/third-party/github.com/bahlo/generic-list-go/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2009 The Go Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+ * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/third-party/github.com/sirupsen/logrus/LICENSE b/third-party/github.com/buger/jsonparser/LICENSE
similarity index 86%
rename from third-party/github.com/sirupsen/logrus/LICENSE
rename to third-party/github.com/buger/jsonparser/LICENSE
index f090cb42f..ac25aeb7d 100644
--- a/third-party/github.com/sirupsen/logrus/LICENSE
+++ b/third-party/github.com/buger/jsonparser/LICENSE
@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
-Copyright (c) 2014 Simon Eskildsen
+Copyright (c) 2016 Leonid Bugaev
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/third-party/github.com/invopop/jsonschema/COPYING b/third-party/github.com/invopop/jsonschema/COPYING
new file mode 100644
index 000000000..2993ec085
--- /dev/null
+++ b/third-party/github.com/invopop/jsonschema/COPYING
@@ -0,0 +1,19 @@
+Copyright (C) 2014 Alec Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/third-party/github.com/wk8/go-ordered-map/v2/LICENSE b/third-party/github.com/wk8/go-ordered-map/v2/LICENSE
new file mode 100644
index 000000000..8dada3eda
--- /dev/null
+++ b/third-party/github.com/wk8/go-ordered-map/v2/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
] |