-
+
```json
{
"servers": {
@@ -85,11 +85,6 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
> **Note:** Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
-> β οΈ **Public Preview Status:** The **remote** GitHub MCP Server is currently in Public Preview. During preview, access may be gated depending on authentication type and surface:
-> - OAuth: Subject to GitHub Copilot Editor Preview Policy until GA
-> - PAT: Controlled via your organization's PAT policies
-> - MCP Servers in Copilot policy: Enables/disables access to all MCP servers in VS Code, with other Copilot editors migrating to this policy in the coming months.
-
### Configuration
See [Remote Server Documentation](/docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server.
@@ -130,7 +125,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"
@@ -241,10 +236,11 @@ 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
+- **[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[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.
@@ -295,6 +291,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 |
@@ -533,6 +530,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)
@@ -600,6 +598,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)
@@ -702,11 +701,6 @@ The following sets of tools are available (all are on by default):
- `pullNumber`: Pull request number (number, required)
- `repo`: Repository name (string, required)
-- **get_pull_request_comments** - Get pull request comments
- - `owner`: Repository owner (string, required)
- - `pullNumber`: Pull request number (number, required)
- - `repo`: Repository name (string, required)
-
- **get_pull_request_diff** - Get pull request diff
- `owner`: Repository owner (string, required)
- `pullNumber`: Pull request number (number, required)
@@ -719,6 +713,11 @@ The following sets of tools are available (all are on by default):
- `pullNumber`: Pull request number (number, required)
- `repo`: Repository name (string, required)
+- **get_pull_request_review_comments** - Get pull request review comments
+ - `owner`: Repository owner (string, required)
+ - `pullNumber`: Pull request number (number, required)
+ - `repo`: Repository name (string, required)
+
- **get_pull_request_reviews** - Get pull request reviews
- `owner`: Repository owner (string, required)
- `pullNumber`: Pull request number (number, required)
@@ -812,6 +811,7 @@ The following sets of tools are available (all are on by default):
- `autoInit`: Initialize with README (boolean, optional)
- `description`: Repository description (string, optional)
- `name`: Repository name (string, required)
+ - `organization`: Organization to create the repository in (omit to create in your personal account) (string, optional)
- `private`: Whether repo should be private (boolean, optional)
- **delete_file** - Delete file
@@ -827,6 +827,7 @@ The following sets of tools are available (all are on by default):
- `repo`: Repository name (string, required)
- **get_commit** - Get commit details
+ - `include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
- `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)
@@ -844,6 +845,11 @@ The following sets of tools are available (all are on by default):
- `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)
@@ -890,6 +896,7 @@ The following sets of tools are available (all are on by default):
- `sort`: Sort field ('indexed' only) (string, optional)
- **search_repositories** - Search repositories
+ - `minimal_output`: Return minimal repository information (default: true). When false, returns full GitHub API repository objects. (boolean, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `query`: Repository search query. Examples: 'machine learning in:name stars:>1000 language:python', 'topic:react', 'user:facebook'. Supports advanced search syntax for precise filtering. (string, required)
@@ -916,6 +923,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
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/README.md b/docs/installation-guides/README.md
index f55cc6bef..13af2f7aa 100644
--- a/docs/installation-guides/README.md
+++ b/docs/installation-guides/README.md
@@ -6,6 +6,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
+- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE
## Support by Host Application
@@ -19,6 +20,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
| Claude Code | β
| β
PAT + β No OAuth| GitHub MCP Server binary or remote URL, GitHub PAT | Easy |
| Claude Desktop | β
| β
PAT + β No OAuth | Docker or Go build, GitHub PAT | Moderate |
| Cursor | β
| β
PAT + β No OAuth | Docker or Go build, GitHub PAT | Easy |
+| Google Gemini CLI | β
| β
PAT + β No OAuth | Docker or Go build, GitHub PAT | Easy |
| Windsurf | β
| β
PAT + β No OAuth | Docker or Go build, GitHub PAT | Easy |
| Copilot in Xcode | β
| β
PAT + β No OAuth | Local: Docker or Go build, GitHub PAT
Remote: Copilot for Xcode latest version | Easy |
| Copilot in Eclipse | β
| β
PAT + β No OAuth | Local: Docker or Go build, GitHub PAT
Remote: TBD | Easy |
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/installation-guides/install-gemini-cli.md b/docs/installation-guides/install-gemini-cli.md
new file mode 100644
index 000000000..21abc8653
--- /dev/null
+++ b/docs/installation-guides/install-gemini-cli.md
@@ -0,0 +1,156 @@
+# Install GitHub MCP Server in Google Gemini CLI
+
+## Prerequisites
+
+1. Google Gemini CLI installed (see [official Gemini CLI documentation](https://github.com/google-gemini/gemini-cli))
+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
+
+
+Storing Your PAT Securely
+
+
+For security, avoid hardcoding your token. Create or update `~/.gemini/.env` (where `~` is your home or project directory) with your PAT:
+
+```bash
+# ~/.gemini/.env
+GITHUB_PAT=your_token_here
+```
+
+
+
+## GitHub MCP Server Configuration
+
+MCP servers for Gemini CLI are configured in its settings JSON under an `mcpServers` key.
+
+- **Global configuration**: `~/.gemini/settings.json` where `~` is your home directory
+- **Project-specific**: `.gemini/settings.json` in your project directory
+
+After securely storing your PAT, you can add the GitHub MCP server configuration to your settings file using one of the methods below. You may need to restart the Gemini CLI for changes to take effect.
+
+> **Note:** For the most up-to-date configuration options, see the [main README.md](../../README.md).
+
+### Method 1: Remote Server (Recommended)
+
+The simplest way is to use GitHub's hosted MCP server:
+
+```json
+// ~/.gemini/settings.json
+{
+ "mcpServers": {
+ "github": {
+ "httpUrl": "https://api.githubcopilot.com/mcp/",
+ "trust": true,
+ "headers": {
+ "Authorization": "Bearer $GITHUB_PAT"
+ }
+ }
+ }
+}
+```
+
+### Method 2: Local Docker
+
+With docker running, you can run the GitHub MCP server in a container:
+
+```json
+// ~/.gemini/settings.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": "$GITHUB_PAT"
+ }
+ }
+ }
+}
+```
+
+### Method 3: Binary
+
+You can download the latest binary release from the [GitHub releases page](https://github.com/github/github-mcp-server/releases) or build it from source by running `go build -o github-mcp-server ./cmd/github-mcp-server`.
+
+Then, replacing `/path/to/binary` with the actual path to your binary, configure Gemini CLI with:
+
+```json
+// ~/.gemini/settings.json
+{
+ "mcpServers": {
+ "github": {
+ "command": "/path/to/binary",
+ "args": ["stdio"],
+ "env": {
+ "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
+ }
+ }
+ }
+}
+```
+
+## Verification
+
+To verify that the GitHub MCP server has been configured, start Gemini CLI in your terminal with `gemini`, then:
+
+1. **Check MCP server status**:
+
+ ```
+ /mcp list
+ ```
+
+ ```
+ βΉConfigured MCP servers:
+
+ π’ github - Ready (96 tools, 2 prompts)
+ Tools:
+ - github__add_comment_to_pending_review
+ - github__add_issue_comment
+ - github__add_sub_issue
+ ...
+ ```
+
+2. **Test with a prompt**
+ ```
+ List my GitHub repositories
+ ```
+
+## Troubleshooting
+
+### Local Server Issues
+
+- **Docker errors**: Ensure Docker Desktop is running
+ ```bash
+ docker --version
+ ```
+- **Image pull failures**: Try `docker logout ghcr.io` then retry
+- **Docker not found**: Install Docker Desktop and ensure it's running
+
+### Authentication Issues
+
+- **Invalid PAT**: Verify your GitHub PAT has correct scopes:
+ - `repo` - Repository operations
+ - `read:packages` - Docker image access (if using Docker)
+- **Token expired**: Generate a new GitHub PAT
+
+### Configuration Issues
+
+- **Invalid JSON**: Validate your configuration:
+ ```bash
+ cat ~/.gemini/settings.json | jq .
+ ```
+- **MCP connection issues**: Check logs for connection errors:
+ ```bash
+ gemini --debug "test command"
+ ```
+
+## References
+
+- Gemini CLI Docs > [MCP Configuration Structure](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html#configuration-structure)
diff --git a/docs/installation-guides/install-other-copilot-ides.md b/docs/installation-guides/install-other-copilot-ides.md
index 38b48bbbd..a3200179c 100644
--- a/docs/installation-guides/install-other-copilot-ides.md
+++ b/docs/installation-guides/install-other-copilot-ides.md
@@ -12,33 +12,34 @@ Quick setup guide for the GitHub MCP server in GitHub Copilot across different I
## Visual Studio
-Requires Visual Studio 2022 version 17.14 or later.
+Requires Visual Studio 2022 version 17.14.9 or later.
### Remote Server (Recommended)
The remote GitHub MCP server is hosted by GitHub and provides automatic updates with no local setup required.
#### Configuration
-1. Go to **Tools** β **Options** β **GitHub** β **Copilot** β **MCP Servers**
+1. Create an `.mcp.json` file in your solution or %USERPROFILE% directory.
2. Add this configuration:
```json
{
"servers": {
"github": {
- "url": "https://api.githubcopilot.com/mcp/",
- "authorization_token": "Bearer YOUR_GITHUB_PAT"
+ "url": "https://api.githubcopilot.com/mcp/"
}
}
}
```
-3. Restart Visual Studio
+3. Save the file. Wait for CodeLens to update to offer a way to authenticate to the new server, activate that and pick the GitHub account to authenticate with.
+4. In the GitHub Copilot Chat window, switch to Agent mode.
+5. Activate the tool picker in the Chat window and enable one or more tools from the "github" MCP server.
### Local Server
For users who prefer to run the GitHub MCP server locally. Requires Docker installed and running.
#### Configuration
-1. Create an `.mcp.json` file in your solution directory
+1. Create an `.mcp.json` file in your solution or %USERPROFILE% directory.
2. Add this configuration:
```json
{
@@ -65,9 +66,11 @@ For users who prefer to run the GitHub MCP server locally. Requires Docker insta
}
}
```
-3. Save the file and restart Visual Studio
+3. Save the file. Wait for CodeLens to update to offer a way to provide user inputs, activate that and paste in a PAT you generate from https://github.com/settings/tokens.
+4. In the GitHub Copilot Chat window, switch to Agent mode.
+5. Activate the tool picker in the Chat window and enable one or more tools from the "github" MCP server.
-**Documentation:** [Visual Studio MCP Guide](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022)
+**Documentation:** [Visual Studio MCP Guide](https://learn.microsoft.com/visualstudio/ide/mcp-servers)
---
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/go.mod b/go.mod
index a2a86feaf..1f215fdc0 100644
--- a/go.mod
+++ b/go.mod
@@ -5,18 +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/spf13/cobra v1.9.1
github.com/spf13/viper v1.20.1
- github.com/stretchr/testify v1.10.0
+ github.com/stretchr/testify v1.11.1
)
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 33395e6bb..72730b820 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=
@@ -81,10 +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.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
-github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
+github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
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=
diff --git a/internal/ghmcp/server.go b/internal/ghmcp/server.go
index 5fb9582b9..7ad71532f 100644
--- a/internal/ghmcp/server.go
+++ b/internal/ghmcp/server.go
@@ -47,6 +47,9 @@ type MCPServerConfig struct {
// Translator provides translated text for the server tooling
Translator translations.TranslationHelperFunc
+
+ // Content window size
+ ContentWindowSize int
}
const stdioServerLogPrefix = "stdioserver"
@@ -132,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 {
@@ -180,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.
@@ -191,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)
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__/create_repository.snap b/pkg/github/__toolsnaps__/create_repository.snap
index aaba75f3c..6ed2dbf41 100644
--- a/pkg/github/__toolsnaps__/create_repository.snap
+++ b/pkg/github/__toolsnaps__/create_repository.snap
@@ -3,7 +3,7 @@
"title": "Create repository",
"readOnlyHint": false
},
- "description": "Create a new GitHub repository in your account",
+ "description": "Create a new GitHub repository in your account or specified organization",
"inputSchema": {
"properties": {
"autoInit": {
@@ -18,6 +18,10 @@
"description": "Repository name",
"type": "string"
},
+ "organization": {
+ "description": "Organization to create the repository in (omit to create in your personal account)",
+ "type": "string"
+ },
"private": {
"description": "Whether repo should be private",
"type": "boolean"
diff --git a/pkg/github/__toolsnaps__/get_commit.snap b/pkg/github/__toolsnaps__/get_commit.snap
index af0038110..1c2ecc9a3 100644
--- a/pkg/github/__toolsnaps__/get_commit.snap
+++ b/pkg/github/__toolsnaps__/get_commit.snap
@@ -6,6 +6,11 @@
"description": "Get details for a commit from a GitHub repository",
"inputSchema": {
"properties": {
+ "include_diff": {
+ "default": true,
+ "description": "Whether to include file diffs and stats in the response. Default is true.",
+ "type": "boolean"
+ },
"owner": {
"description": "Repository owner",
"type": "string"
diff --git a/pkg/github/__toolsnaps__/get_pull_request_comments.snap b/pkg/github/__toolsnaps__/get_pull_request_review_comments.snap
similarity index 60%
rename from pkg/github/__toolsnaps__/get_pull_request_comments.snap
rename to pkg/github/__toolsnaps__/get_pull_request_review_comments.snap
index 6699f6d97..92996fec2 100644
--- a/pkg/github/__toolsnaps__/get_pull_request_comments.snap
+++ b/pkg/github/__toolsnaps__/get_pull_request_review_comments.snap
@@ -1,9 +1,9 @@
{
"annotations": {
- "title": "Get pull request comments",
+ "title": "Get pull request review comments",
"readOnlyHint": true
},
- "description": "Get comments for a specific pull request.",
+ "description": "Get pull request review comments. They are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request.",
"inputSchema": {
"properties": {
"owner": {
@@ -26,5 +26,5 @@
],
"type": "object"
},
- "name": "get_pull_request_comments"
+ "name": "get_pull_request_review_comments"
}
\ No newline at end of file
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__/search_repositories.snap b/pkg/github/__toolsnaps__/search_repositories.snap
index d283a2cc0..f350c8e2b 100644
--- a/pkg/github/__toolsnaps__/search_repositories.snap
+++ b/pkg/github/__toolsnaps__/search_repositories.snap
@@ -6,6 +6,11 @@
"description": "Find GitHub repositories by name, description, readme, topics, or other metadata. Perfect for discovering projects, finding examples, or locating specific repositories across GitHub.",
"inputSchema": {
"properties": {
+ "minimal_output": {
+ "default": true,
+ "description": "Return minimal repository information (default: true). When false, returns full GitHub API repository objects.",
+ "type": "boolean"
+ },
"page": {
"description": "Page number for pagination (min 1)",
"minimum": 1,
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 38719f155..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
diff --git a/pkg/github/actions_test.go b/pkg/github/actions_test.go
index 3d7521125..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"
@@ -807,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)
@@ -1036,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)
@@ -1095,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",
@@ -1142,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",
@@ -1162,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/gists.go b/pkg/github/gists.go
index fce34f6a8..3f1645f3e 100644
--- a/pkg/github/gists.go
+++ b/pkg/github/gists.go
@@ -165,7 +165,11 @@ func CreateGist(getClient GetClientFn, t translations.TranslationHelperFunc) (to
return mcp.NewToolResultError(fmt.Sprintf("failed to create gist: %s", string(body))), nil
}
- r, err := json.Marshal(createdGist)
+ minimalResponse := MinimalResponse{
+ URL: createdGist.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -249,7 +253,11 @@ func UpdateGist(getClient GetClientFn, t translations.TranslationHelperFunc) (to
return mcp.NewToolResultError(fmt.Sprintf("failed to update gist: %s", string(body))), nil
}
- r, err := json.Marshal(updatedGist)
+ minimalResponse := MinimalResponse{
+ URL: updatedGist.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
diff --git a/pkg/github/gists_test.go b/pkg/github/gists_test.go
index 49d63a252..9b8b4eb6e 100644
--- a/pkg/github/gists_test.go
+++ b/pkg/github/gists_test.go
@@ -321,23 +321,12 @@ func Test_CreateGist(t *testing.T) {
// Parse the result and get the text content
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var gist *github.Gist
+ // Unmarshal and verify the minimal result
+ var gist MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &gist)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedGist.ID, *gist.ID)
- assert.Equal(t, *tc.expectedGist.Description, *gist.Description)
- assert.Equal(t, *tc.expectedGist.HTMLURL, *gist.HTMLURL)
- assert.Equal(t, *tc.expectedGist.Public, *gist.Public)
-
- // Verify file content
- for filename, expectedFile := range tc.expectedGist.Files {
- actualFile, exists := gist.Files[filename]
- assert.True(t, exists)
- assert.Equal(t, *expectedFile.Filename, *actualFile.Filename)
- assert.Equal(t, *expectedFile.Content, *actualFile.Content)
- }
+ assert.Equal(t, tc.expectedGist.GetHTMLURL(), gist.URL)
})
}
}
@@ -486,22 +475,12 @@ func Test_UpdateGist(t *testing.T) {
// Parse the result and get the text content
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var gist *github.Gist
- err = json.Unmarshal([]byte(textContent.Text), &gist)
+ // Unmarshal and verify the minimal result
+ var updateResp MinimalResponse
+ err = json.Unmarshal([]byte(textContent.Text), &updateResp)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedGist.ID, *gist.ID)
- assert.Equal(t, *tc.expectedGist.Description, *gist.Description)
- assert.Equal(t, *tc.expectedGist.HTMLURL, *gist.HTMLURL)
-
- // Verify file content
- for filename, expectedFile := range tc.expectedGist.Files {
- actualFile, exists := gist.Files[filename]
- assert.True(t, exists)
- assert.Equal(t, *expectedFile.Filename, *actualFile.Filename)
- assert.Equal(t, *expectedFile.Content, *actualFile.Content)
- }
+ assert.Equal(t, tc.expectedGist.GetHTMLURL(), updateResp.URL)
})
}
}
diff --git a/pkg/github/issues.go b/pkg/github/issues.go
index 3a1440489..01ce7b42e 100644
--- a/pkg/github/issues.go
+++ b/pkg/github/issues.go
@@ -553,39 +553,39 @@ func RemoveSubIssue(getClient GetClientFn, t translations.TranslationHelperFunc)
}
client, err := getClient(ctx)
- if err != nil {
- return nil, fmt.Errorf("failed to get GitHub client: %w", err)
- }
-
- subIssueRequest := github.SubIssueRequest{
- SubIssueID: int64(subIssueID),
- }
-
- subIssue, resp, err := client.SubIssue.Remove(ctx, owner, repo, int64(issueNumber), subIssueRequest)
- if err != nil {
- return ghErrors.NewGitHubAPIErrorResponse(ctx,
- "failed to remove sub-issue",
- 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 remove sub-issue: %s", string(body))), nil
- }
-
- r, err := json.Marshal(subIssue)
- if err != nil {
- return nil, fmt.Errorf("failed to marshal response: %w", err)
- }
-
- return mcp.NewToolResultText(string(r)), nil
- }
+ if err != nil {
+ return nil, fmt.Errorf("failed to get GitHub client: %w", err)
+ }
+
+ subIssueRequest := github.SubIssueRequest{
+ SubIssueID: int64(subIssueID),
+ }
+
+ subIssue, resp, err := client.SubIssue.Remove(ctx, owner, repo, int64(issueNumber), subIssueRequest)
+ if err != nil {
+ return ghErrors.NewGitHubAPIErrorResponse(ctx,
+ "failed to remove sub-issue",
+ 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 remove sub-issue: %s", string(body))), nil
+ }
+
+ r, err := json.Marshal(subIssue)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal response: %w", err)
+ }
+
+ return mcp.NewToolResultText(string(r)), nil
+ }
}
// ReprioritizeSubIssue creates a tool to reprioritize a sub-issue to a different position in the parent list.
@@ -788,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")
@@ -832,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),
@@ -841,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)
@@ -859,7 +872,12 @@ func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
return mcp.NewToolResultError(fmt.Sprintf("failed to create issue: %s", string(body))), nil
}
- r, err := json.Marshal(issue)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: issue.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -1129,6 +1147,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")
@@ -1199,6 +1220,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)
@@ -1217,7 +1247,12 @@ func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
return mcp.NewToolResultError(fmt.Sprintf("failed to update issue: %s", string(body))), nil
}
- r, err := json.Marshal(updatedIssue)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: updatedIssue.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -1527,7 +1562,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 249fadef8..5a0d409a6 100644
--- a/pkg/github/issues_test.go
+++ b/pkg/github/issues_test.go
@@ -581,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
@@ -593,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 {
@@ -614,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),
),
@@ -627,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,
@@ -708,35 +712,12 @@ func Test_CreateIssue(t *testing.T) {
require.NoError(t, err)
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var returnedIssue github.Issue
+ // Unmarshal and verify the minimal result
+ var returnedIssue MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &returnedIssue)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedIssue.Number, *returnedIssue.Number)
- assert.Equal(t, *tc.expectedIssue.Title, *returnedIssue.Title)
- assert.Equal(t, *tc.expectedIssue.State, *returnedIssue.State)
- assert.Equal(t, *tc.expectedIssue.HTMLURL, *returnedIssue.HTMLURL)
-
- if tc.expectedIssue.Body != nil {
- assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
- }
-
- // Check assignees if expected
- if len(tc.expectedIssue.Assignees) > 0 {
- assert.Equal(t, len(tc.expectedIssue.Assignees), len(returnedIssue.Assignees))
- for i, assignee := range returnedIssue.Assignees {
- assert.Equal(t, *tc.expectedIssue.Assignees[i].Login, *assignee.Login)
- }
- }
-
- // Check labels if expected
- if len(tc.expectedIssue.Labels) > 0 {
- assert.Equal(t, len(tc.expectedIssue.Labels), len(returnedIssue.Labels))
- for i, label := range returnedIssue.Labels {
- assert.Equal(t, *tc.expectedIssue.Labels[i].Name, *label.Name)
- }
- }
+ assert.Equal(t, tc.expectedIssue.GetHTMLURL(), returnedIssue.URL)
})
}
}
@@ -1066,6 +1047,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
@@ -1078,6 +1060,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 {
@@ -1100,6 +1083,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),
),
@@ -1115,6 +1099,7 @@ func Test_UpdateIssue(t *testing.T) {
"labels": []any{"bug", "priority"},
"assignees": []any{"assignee1", "assignee2"},
"milestone": float64(5),
+ "type": "Bug",
},
expectError: false,
expectedIssue: mockIssue,
@@ -1126,9 +1111,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")},
}),
),
),
@@ -1136,14 +1122,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")},
},
},
{
@@ -1218,41 +1206,12 @@ func Test_UpdateIssue(t *testing.T) {
// Parse the result and get the text content if no error
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var returnedIssue github.Issue
- err = json.Unmarshal([]byte(textContent.Text), &returnedIssue)
+ // Unmarshal and verify the minimal result
+ var updateResp MinimalResponse
+ err = json.Unmarshal([]byte(textContent.Text), &updateResp)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedIssue.Number, *returnedIssue.Number)
- assert.Equal(t, *tc.expectedIssue.Title, *returnedIssue.Title)
- assert.Equal(t, *tc.expectedIssue.State, *returnedIssue.State)
- assert.Equal(t, *tc.expectedIssue.HTMLURL, *returnedIssue.HTMLURL)
-
- if tc.expectedIssue.Body != nil {
- assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
- }
-
- // Check assignees if expected
- if len(tc.expectedIssue.Assignees) > 0 {
- assert.Len(t, returnedIssue.Assignees, len(tc.expectedIssue.Assignees))
- for i, assignee := range returnedIssue.Assignees {
- assert.Equal(t, *tc.expectedIssue.Assignees[i].Login, *assignee.Login)
- }
- }
-
- // Check labels if expected
- if len(tc.expectedIssue.Labels) > 0 {
- assert.Len(t, returnedIssue.Labels, len(tc.expectedIssue.Labels))
- for i, label := range returnedIssue.Labels {
- assert.Equal(t, *tc.expectedIssue.Labels[i].Name, *label.Name)
- }
- }
-
- // Check milestone if expected
- if tc.expectedIssue.Milestone != nil {
- assert.NotNil(t, returnedIssue.Milestone)
- assert.Equal(t, *tc.expectedIssue.Milestone.Number, *returnedIssue.Milestone.Number)
- }
+ assert.Equal(t, tc.expectedIssue.GetHTMLURL(), updateResp.URL)
})
}
}
diff --git a/pkg/github/minimal_types.go b/pkg/github/minimal_types.go
new file mode 100644
index 000000000..0c3c220aa
--- /dev/null
+++ b/pkg/github/minimal_types.go
@@ -0,0 +1,204 @@
+package github
+
+import "github.com/google/go-github/v74/github"
+
+// MinimalUser is the output type for user and organization search results.
+type MinimalUser struct {
+ Login string `json:"login"`
+ ID int64 `json:"id,omitempty"`
+ ProfileURL string `json:"profile_url,omitempty"`
+ AvatarURL string `json:"avatar_url,omitempty"`
+ Details *UserDetails `json:"details,omitempty"` // Optional field for additional user details
+}
+
+// MinimalSearchUsersResult is the trimmed output type for user search results.
+type MinimalSearchUsersResult struct {
+ TotalCount int `json:"total_count"`
+ IncompleteResults bool `json:"incomplete_results"`
+ Items []MinimalUser `json:"items"`
+}
+
+// MinimalRepository is the trimmed output type for repository objects to reduce verbosity.
+type MinimalRepository struct {
+ ID int64 `json:"id"`
+ Name string `json:"name"`
+ FullName string `json:"full_name"`
+ Description string `json:"description,omitempty"`
+ HTMLURL string `json:"html_url"`
+ Language string `json:"language,omitempty"`
+ Stars int `json:"stargazers_count"`
+ Forks int `json:"forks_count"`
+ OpenIssues int `json:"open_issues_count"`
+ UpdatedAt string `json:"updated_at,omitempty"`
+ CreatedAt string `json:"created_at,omitempty"`
+ Topics []string `json:"topics,omitempty"`
+ Private bool `json:"private"`
+ Fork bool `json:"fork"`
+ Archived bool `json:"archived"`
+ DefaultBranch string `json:"default_branch,omitempty"`
+}
+
+// MinimalSearchRepositoriesResult is the trimmed output type for repository search results.
+type MinimalSearchRepositoriesResult struct {
+ TotalCount int `json:"total_count"`
+ IncompleteResults bool `json:"incomplete_results"`
+ Items []MinimalRepository `json:"items"`
+}
+
+// MinimalCommitAuthor represents commit author information.
+type MinimalCommitAuthor struct {
+ Name string `json:"name,omitempty"`
+ Email string `json:"email,omitempty"`
+ Date string `json:"date,omitempty"`
+}
+
+// MinimalCommitInfo represents core commit information.
+type MinimalCommitInfo struct {
+ Message string `json:"message"`
+ Author *MinimalCommitAuthor `json:"author,omitempty"`
+ Committer *MinimalCommitAuthor `json:"committer,omitempty"`
+}
+
+// MinimalCommitStats represents commit statistics.
+type MinimalCommitStats struct {
+ Additions int `json:"additions,omitempty"`
+ Deletions int `json:"deletions,omitempty"`
+ Total int `json:"total,omitempty"`
+}
+
+// MinimalCommitFile represents a file changed in a commit.
+type MinimalCommitFile struct {
+ Filename string `json:"filename"`
+ Status string `json:"status,omitempty"`
+ Additions int `json:"additions,omitempty"`
+ Deletions int `json:"deletions,omitempty"`
+ Changes int `json:"changes,omitempty"`
+}
+
+// MinimalCommit is the trimmed output type for commit objects.
+type MinimalCommit struct {
+ SHA string `json:"sha"`
+ HTMLURL string `json:"html_url"`
+ Commit *MinimalCommitInfo `json:"commit,omitempty"`
+ Author *MinimalUser `json:"author,omitempty"`
+ Committer *MinimalUser `json:"committer,omitempty"`
+ Stats *MinimalCommitStats `json:"stats,omitempty"`
+ Files []MinimalCommitFile `json:"files,omitempty"`
+}
+
+// MinimalRelease is the trimmed output type for release objects.
+type MinimalRelease struct {
+ ID int64 `json:"id"`
+ TagName string `json:"tag_name"`
+ Name string `json:"name,omitempty"`
+ Body string `json:"body,omitempty"`
+ HTMLURL string `json:"html_url"`
+ PublishedAt string `json:"published_at,omitempty"`
+ Prerelease bool `json:"prerelease"`
+ Draft bool `json:"draft"`
+ Author *MinimalUser `json:"author,omitempty"`
+}
+
+// MinimalBranch is the trimmed output type for branch objects.
+type MinimalBranch struct {
+ Name string `json:"name"`
+ SHA string `json:"sha"`
+ Protected bool `json:"protected"`
+}
+
+// MinimalResponse represents a minimal response for all CRUD operations.
+// Success is implicit in the HTTP response status, and all other information
+// can be derived from the URL or fetched separately if needed.
+type MinimalResponse struct {
+ URL string `json:"url"`
+}
+
+// Helper functions
+
+// convertToMinimalCommit converts a GitHub API RepositoryCommit to MinimalCommit
+func convertToMinimalCommit(commit *github.RepositoryCommit, includeDiffs bool) MinimalCommit {
+ minimalCommit := MinimalCommit{
+ SHA: commit.GetSHA(),
+ HTMLURL: commit.GetHTMLURL(),
+ }
+
+ if commit.Commit != nil {
+ minimalCommit.Commit = &MinimalCommitInfo{
+ Message: commit.Commit.GetMessage(),
+ }
+
+ if commit.Commit.Author != nil {
+ minimalCommit.Commit.Author = &MinimalCommitAuthor{
+ Name: commit.Commit.Author.GetName(),
+ Email: commit.Commit.Author.GetEmail(),
+ }
+ if commit.Commit.Author.Date != nil {
+ minimalCommit.Commit.Author.Date = commit.Commit.Author.Date.Format("2006-01-02T15:04:05Z")
+ }
+ }
+
+ if commit.Commit.Committer != nil {
+ minimalCommit.Commit.Committer = &MinimalCommitAuthor{
+ Name: commit.Commit.Committer.GetName(),
+ Email: commit.Commit.Committer.GetEmail(),
+ }
+ if commit.Commit.Committer.Date != nil {
+ minimalCommit.Commit.Committer.Date = commit.Commit.Committer.Date.Format("2006-01-02T15:04:05Z")
+ }
+ }
+ }
+
+ if commit.Author != nil {
+ minimalCommit.Author = &MinimalUser{
+ Login: commit.Author.GetLogin(),
+ ID: commit.Author.GetID(),
+ ProfileURL: commit.Author.GetHTMLURL(),
+ AvatarURL: commit.Author.GetAvatarURL(),
+ }
+ }
+
+ if commit.Committer != nil {
+ minimalCommit.Committer = &MinimalUser{
+ Login: commit.Committer.GetLogin(),
+ ID: commit.Committer.GetID(),
+ ProfileURL: commit.Committer.GetHTMLURL(),
+ AvatarURL: commit.Committer.GetAvatarURL(),
+ }
+ }
+
+ // Only include stats and files if includeDiffs is true
+ if includeDiffs {
+ if commit.Stats != nil {
+ minimalCommit.Stats = &MinimalCommitStats{
+ Additions: commit.Stats.GetAdditions(),
+ Deletions: commit.Stats.GetDeletions(),
+ Total: commit.Stats.GetTotal(),
+ }
+ }
+
+ if len(commit.Files) > 0 {
+ minimalCommit.Files = make([]MinimalCommitFile, 0, len(commit.Files))
+ for _, file := range commit.Files {
+ minimalFile := MinimalCommitFile{
+ Filename: file.GetFilename(),
+ Status: file.GetStatus(),
+ Additions: file.GetAdditions(),
+ Deletions: file.GetDeletions(),
+ Changes: file.GetChanges(),
+ }
+ minimalCommit.Files = append(minimalCommit.Files, minimalFile)
+ }
+ }
+ }
+
+ return minimalCommit
+}
+
+// convertToMinimalBranch converts a GitHub API Branch to MinimalBranch
+func convertToMinimalBranch(branch *github.Branch) MinimalBranch {
+ return MinimalBranch{
+ Name: branch.GetName(),
+ SHA: branch.GetCommit().GetSHA(),
+ Protected: branch.GetProtected(),
+ }
+}
diff --git a/pkg/github/pullrequests.go b/pkg/github/pullrequests.go
index 63c5594d3..b2e4e9290 100644
--- a/pkg/github/pullrequests.go
+++ b/pkg/github/pullrequests.go
@@ -193,7 +193,12 @@ func CreatePullRequest(getClient GetClientFn, t translations.TranslationHelperFu
return mcp.NewToolResultError(fmt.Sprintf("failed to create pull request: %s", string(body))), nil
}
- r, err := json.Marshal(pr)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: pr.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -464,7 +469,12 @@ func UpdatePullRequest(getClient GetClientFn, getGQLClient GetGQLClientFn, t tra
}
}()
- r, err := json.Marshal(finalPR)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: finalPR.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return mcp.NewToolResultError(fmt.Sprintf("Failed to marshal response: %v", err)), nil
}
@@ -965,12 +975,12 @@ func UpdatePullRequestBranch(getClient GetClientFn, t translations.TranslationHe
}
}
-// GetPullRequestComments creates a tool to get the review comments on a pull request.
-func GetPullRequestComments(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
- return mcp.NewTool("get_pull_request_comments",
- mcp.WithDescription(t("TOOL_GET_PULL_REQUEST_COMMENTS_DESCRIPTION", "Get comments for a specific pull request.")),
+// GetPullRequestReviewComments creates a tool to get the review comments on a pull request.
+func GetPullRequestReviewComments(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
+ return mcp.NewTool("get_pull_request_review_comments",
+ mcp.WithDescription(t("TOOL_GET_PULL_REQUEST_REVIEW_COMMENTS_DESCRIPTION", "Get pull request review comments. They are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request.")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
- Title: t("TOOL_GET_PULL_REQUEST_COMMENTS_USER_TITLE", "Get pull request comments"),
+ Title: t("TOOL_GET_PULL_REQUEST_REVIEW_COMMENTS_USER_TITLE", "Get pull request review comments"),
ReadOnlyHint: ToBoolPtr(true),
}),
mcp.WithString("owner",
@@ -1013,7 +1023,7 @@ func GetPullRequestComments(getClient GetClientFn, t translations.TranslationHel
comments, resp, err := client.PullRequests.ListComments(ctx, owner, repo, pullNumber, opts)
if err != nil {
return ghErrors.NewGitHubAPIErrorResponse(ctx,
- "failed to get pull request comments",
+ "failed to get pull request review comments",
resp,
err,
), nil
@@ -1025,7 +1035,7 @@ func GetPullRequestComments(getClient GetClientFn, t translations.TranslationHel
if err != nil {
return nil, fmt.Errorf("failed to read response body: %w", err)
}
- return mcp.NewToolResultError(fmt.Sprintf("failed to get pull request comments: %s", string(body))), nil
+ return mcp.NewToolResultError(fmt.Sprintf("failed to get pull request review comments: %s", string(body))), nil
}
r, err := json.Marshal(comments)
diff --git a/pkg/github/pullrequests_test.go b/pkg/github/pullrequests_test.go
index ed6921477..18fc8d87d 100644
--- a/pkg/github/pullrequests_test.go
+++ b/pkg/github/pullrequests_test.go
@@ -381,47 +381,11 @@ func Test_UpdatePullRequest(t *testing.T) {
// Parse the result and get the text content
textContent := getTextResult(t, result)
- // Unmarshal and verify the successful result
- var returnedPR github.PullRequest
- err = json.Unmarshal([]byte(textContent.Text), &returnedPR)
+ // Unmarshal and verify the minimal result
+ var updateResp MinimalResponse
+ err = json.Unmarshal([]byte(textContent.Text), &updateResp)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedPR.Number, *returnedPR.Number)
- if tc.expectedPR.Title != nil {
- assert.Equal(t, *tc.expectedPR.Title, *returnedPR.Title)
- }
- if tc.expectedPR.Body != nil {
- assert.Equal(t, *tc.expectedPR.Body, *returnedPR.Body)
- }
- if tc.expectedPR.State != nil {
- assert.Equal(t, *tc.expectedPR.State, *returnedPR.State)
- }
- if tc.expectedPR.Base != nil && tc.expectedPR.Base.Ref != nil {
- assert.NotNil(t, returnedPR.Base)
- assert.Equal(t, *tc.expectedPR.Base.Ref, *returnedPR.Base.Ref)
- }
- if tc.expectedPR.MaintainerCanModify != nil {
- assert.Equal(t, *tc.expectedPR.MaintainerCanModify, *returnedPR.MaintainerCanModify)
- }
-
- // Check reviewers if they exist in the expected PR
- if len(tc.expectedPR.RequestedReviewers) > 0 {
- assert.NotNil(t, returnedPR.RequestedReviewers)
- assert.Equal(t, len(tc.expectedPR.RequestedReviewers), len(returnedPR.RequestedReviewers))
-
- // Create maps of reviewer logins for easy comparison
- expectedReviewers := make(map[string]bool)
- for _, reviewer := range tc.expectedPR.RequestedReviewers {
- expectedReviewers[*reviewer.Login] = true
- }
-
- actualReviewers := make(map[string]bool)
- for _, reviewer := range returnedPR.RequestedReviewers {
- actualReviewers[*reviewer.Login] = true
- }
-
- // Compare the maps
- assert.Equal(t, expectedReviewers, actualReviewers)
- }
+ assert.Equal(t, tc.expectedPR.GetHTMLURL(), updateResp.URL)
})
}
}
@@ -599,11 +563,11 @@ func Test_UpdatePullRequest_Draft(t *testing.T) {
textContent := getTextResult(t, result)
- // Unmarshal and verify the successful result
- var returnedPR github.PullRequest
- err = json.Unmarshal([]byte(textContent.Text), &returnedPR)
+ // Unmarshal and verify the minimal result
+ var updateResp MinimalResponse
+ err = json.Unmarshal([]byte(textContent.Text), &updateResp)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedPR.Number, *returnedPR.Number)
+ assert.Equal(t, tc.expectedPR.GetHTMLURL(), updateResp.URL)
})
}
}
@@ -1591,10 +1555,10 @@ func Test_UpdatePullRequestBranch(t *testing.T) {
func Test_GetPullRequestComments(t *testing.T) {
// Verify tool definition once
mockClient := github.NewClient(nil)
- tool, _ := GetPullRequestComments(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+ tool, _ := GetPullRequestReviewComments(stubGetClientFn(mockClient), translations.NullTranslationHelper)
require.NoError(t, toolsnaps.Test(tool.Name, tool))
- assert.Equal(t, "get_pull_request_comments", tool.Name)
+ assert.Equal(t, "get_pull_request_review_comments", tool.Name)
assert.NotEmpty(t, tool.Description)
assert.Contains(t, tool.InputSchema.Properties, "owner")
assert.Contains(t, tool.InputSchema.Properties, "repo")
@@ -1672,7 +1636,7 @@ func Test_GetPullRequestComments(t *testing.T) {
"pullNumber": float64(999),
},
expectError: true,
- expectedErrMsg: "failed to get pull request comments",
+ expectedErrMsg: "failed to get pull request review comments",
},
}
@@ -1680,7 +1644,7 @@ func Test_GetPullRequestComments(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
// Setup client with mock
client := github.NewClient(tc.mockedClient)
- _, handler := GetPullRequestComments(stubGetClientFn(client), translations.NullTranslationHelper)
+ _, handler := GetPullRequestReviewComments(stubGetClientFn(client), translations.NullTranslationHelper)
// Create call request
request := createMCPRequest(tc.requestArgs)
@@ -1988,18 +1952,11 @@ func Test_CreatePullRequest(t *testing.T) {
// Parse the result and get the text content if no error
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var returnedPR github.PullRequest
+ // Unmarshal and verify the minimal result
+ var returnedPR MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &returnedPR)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedPR.Number, *returnedPR.Number)
- assert.Equal(t, *tc.expectedPR.Title, *returnedPR.Title)
- assert.Equal(t, *tc.expectedPR.State, *returnedPR.State)
- assert.Equal(t, *tc.expectedPR.HTMLURL, *returnedPR.HTMLURL)
- assert.Equal(t, *tc.expectedPR.Head.SHA, *returnedPR.Head.SHA)
- assert.Equal(t, *tc.expectedPR.Base.Ref, *returnedPR.Base.Ref)
- assert.Equal(t, *tc.expectedPR.Body, *returnedPR.Body)
- assert.Equal(t, *tc.expectedPR.User.Login, *returnedPR.User.Login)
+ assert.Equal(t, tc.expectedPR.GetHTMLURL(), returnedPR.URL)
})
}
}
diff --git a/pkg/github/repositories.go b/pkg/github/repositories.go
index 0925829a1..cef227ba5 100644
--- a/pkg/github/repositories.go
+++ b/pkg/github/repositories.go
@@ -37,6 +37,10 @@ func GetCommit(getClient GetClientFn, t translations.TranslationHelperFunc) (too
mcp.Required(),
mcp.Description("Commit SHA, branch name, or tag name"),
),
+ mcp.WithBoolean("include_diff",
+ mcp.Description("Whether to include file diffs and stats in the response. Default is true."),
+ mcp.DefaultBool(true),
+ ),
WithPagination(),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -52,6 +56,10 @@ func GetCommit(getClient GetClientFn, t translations.TranslationHelperFunc) (too
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
+ includeDiff, err := OptionalBoolParamWithDefault(request, "include_diff", true)
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
pagination, err := OptionalPaginationParams(request)
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
@@ -84,7 +92,10 @@ func GetCommit(getClient GetClientFn, t translations.TranslationHelperFunc) (too
return mcp.NewToolResultError(fmt.Sprintf("failed to get commit: %s", string(body))), nil
}
- r, err := json.Marshal(commit)
+ // Convert to minimal commit
+ minimalCommit := convertToMinimalCommit(commit, includeDiff)
+
+ r, err := json.Marshal(minimalCommit)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -174,7 +185,13 @@ func ListCommits(getClient GetClientFn, t translations.TranslationHelperFunc) (t
return mcp.NewToolResultError(fmt.Sprintf("failed to list commits: %s", string(body))), nil
}
- r, err := json.Marshal(commits)
+ // Convert to minimal commits
+ minimalCommits := make([]MinimalCommit, len(commits))
+ for i, commit := range commits {
+ minimalCommits[i] = convertToMinimalCommit(commit, false)
+ }
+
+ r, err := json.Marshal(minimalCommits)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -245,7 +262,13 @@ func ListBranches(getClient GetClientFn, t translations.TranslationHelperFunc) (
return mcp.NewToolResultError(fmt.Sprintf("failed to list branches: %s", string(body))), nil
}
- r, err := json.Marshal(branches)
+ // Convert to minimal branches
+ minimalBranches := make([]MinimalBranch, 0, len(branches))
+ for _, branch := range branches {
+ minimalBranches = append(minimalBranches, convertToMinimalBranch(branch))
+ }
+
+ r, err := json.Marshal(minimalBranches)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -370,7 +393,7 @@ func CreateOrUpdateFile(getClient GetClientFn, t translations.TranslationHelperF
// CreateRepository creates a tool to create a new GitHub repository.
func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("create_repository",
- mcp.WithDescription(t("TOOL_CREATE_REPOSITORY_DESCRIPTION", "Create a new GitHub repository in your account")),
+ mcp.WithDescription(t("TOOL_CREATE_REPOSITORY_DESCRIPTION", "Create a new GitHub repository in your account or specified organization")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
Title: t("TOOL_CREATE_REPOSITORY_USER_TITLE", "Create repository"),
ReadOnlyHint: ToBoolPtr(false),
@@ -382,6 +405,9 @@ func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFun
mcp.WithString("description",
mcp.Description("Repository description"),
),
+ mcp.WithString("organization",
+ mcp.Description("Organization to create the repository in (omit to create in your personal account)"),
+ ),
mcp.WithBoolean("private",
mcp.Description("Whether repo should be private"),
),
@@ -398,6 +424,10 @@ func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFun
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
+ organization, err := OptionalParam[string](request, "organization")
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
private, err := OptionalParam[bool](request, "private")
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
@@ -418,7 +448,7 @@ func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFun
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
- createdRepo, resp, err := client.Repositories.Create(ctx, "", repo)
+ createdRepo, resp, err := client.Repositories.Create(ctx, organization, repo)
if err != nil {
return ghErrors.NewGitHubAPIErrorResponse(ctx,
"failed to create repository",
@@ -436,7 +466,12 @@ func CreateRepository(getClient GetClientFn, t translations.TranslationHelperFun
return mcp.NewToolResultError(fmt.Sprintf("failed to create repository: %s", string(body))), nil
}
- r, err := json.Marshal(createdRepo)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: createdRepo.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -707,7 +742,12 @@ func ForkRepository(getClient GetClientFn, t translations.TranslationHelperFunc)
return mcp.NewToolResultError(fmt.Sprintf("failed to fork repository: %s", string(body))), nil
}
- r, err := json.Marshal(forkedRepo)
+ // Return minimal response with just essential information
+ minimalResponse := MinimalResponse{
+ URL: forkedRepo.GetHTMLURL(),
+ }
+
+ r, err := json.Marshal(minimalResponse)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}
@@ -1441,6 +1481,72 @@ func GetLatestRelease(getClient GetClientFn, t translations.TranslationHelperFun
}
}
+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,
diff --git a/pkg/github/repositories_test.go b/pkg/github/repositories_test.go
index 63e577600..468d7c29b 100644
--- a/pkg/github/repositories_test.go
+++ b/pkg/github/repositories_test.go
@@ -737,9 +737,33 @@ func Test_ListCommits(t *testing.T) {
},
},
Author: &github.User{
- Login: github.Ptr("testuser"),
+ Login: github.Ptr("testuser"),
+ ID: github.Ptr(int64(12345)),
+ HTMLURL: github.Ptr("https://github.com/testuser"),
+ AvatarURL: github.Ptr("https://github.com/testuser.png"),
},
HTMLURL: github.Ptr("https://github.com/owner/repo/commit/abc123def456"),
+ Stats: &github.CommitStats{
+ Additions: github.Ptr(10),
+ Deletions: github.Ptr(5),
+ Total: github.Ptr(15),
+ },
+ Files: []*github.CommitFile{
+ {
+ Filename: github.Ptr("src/main.go"),
+ Status: github.Ptr("modified"),
+ Additions: github.Ptr(8),
+ Deletions: github.Ptr(3),
+ Changes: github.Ptr(11),
+ },
+ {
+ Filename: github.Ptr("README.md"),
+ Status: github.Ptr("added"),
+ Additions: github.Ptr(2),
+ Deletions: github.Ptr(2),
+ Changes: github.Ptr(4),
+ },
+ },
},
{
SHA: github.Ptr("def456abc789"),
@@ -752,9 +776,26 @@ func Test_ListCommits(t *testing.T) {
},
},
Author: &github.User{
- Login: github.Ptr("anotheruser"),
+ Login: github.Ptr("anotheruser"),
+ ID: github.Ptr(int64(67890)),
+ HTMLURL: github.Ptr("https://github.com/anotheruser"),
+ AvatarURL: github.Ptr("https://github.com/anotheruser.png"),
},
HTMLURL: github.Ptr("https://github.com/owner/repo/commit/def456abc789"),
+ Stats: &github.CommitStats{
+ Additions: github.Ptr(20),
+ Deletions: github.Ptr(10),
+ Total: github.Ptr(30),
+ },
+ Files: []*github.CommitFile{
+ {
+ Filename: github.Ptr("src/utils.go"),
+ Status: github.Ptr("added"),
+ Additions: github.Ptr(20),
+ Deletions: github.Ptr(10),
+ Changes: github.Ptr(30),
+ },
+ },
},
}
@@ -875,16 +916,23 @@ func Test_ListCommits(t *testing.T) {
textContent := getTextResult(t, result)
// Unmarshal and verify the result
- var returnedCommits []*github.RepositoryCommit
+ var returnedCommits []MinimalCommit
err = json.Unmarshal([]byte(textContent.Text), &returnedCommits)
require.NoError(t, err)
assert.Len(t, returnedCommits, len(tc.expectedCommits))
for i, commit := range returnedCommits {
- assert.Equal(t, *tc.expectedCommits[i].Author, *commit.Author)
- assert.Equal(t, *tc.expectedCommits[i].SHA, *commit.SHA)
- assert.Equal(t, *tc.expectedCommits[i].Commit.Message, *commit.Commit.Message)
- assert.Equal(t, *tc.expectedCommits[i].Author.Login, *commit.Author.Login)
- assert.Equal(t, *tc.expectedCommits[i].HTMLURL, *commit.HTMLURL)
+ assert.Equal(t, tc.expectedCommits[i].GetSHA(), commit.SHA)
+ assert.Equal(t, tc.expectedCommits[i].GetHTMLURL(), commit.HTMLURL)
+ if tc.expectedCommits[i].Commit != nil {
+ assert.Equal(t, tc.expectedCommits[i].Commit.GetMessage(), commit.Commit.Message)
+ }
+ if tc.expectedCommits[i].Author != nil {
+ assert.Equal(t, tc.expectedCommits[i].Author.GetLogin(), commit.Author.Login)
+ }
+
+ // Files and stats are never included in list_commits
+ assert.Nil(t, commit.Files)
+ assert.Nil(t, commit.Stats)
}
})
}
@@ -1067,6 +1115,7 @@ func Test_CreateRepository(t *testing.T) {
assert.NotEmpty(t, tool.Description)
assert.Contains(t, tool.InputSchema.Properties, "name")
assert.Contains(t, tool.InputSchema.Properties, "description")
+ assert.Contains(t, tool.InputSchema.Properties, "organization")
assert.Contains(t, tool.InputSchema.Properties, "private")
assert.Contains(t, tool.InputSchema.Properties, "autoInit")
assert.ElementsMatch(t, tool.InputSchema.Required, []string{"name"})
@@ -1077,7 +1126,6 @@ func Test_CreateRepository(t *testing.T) {
Description: github.Ptr("Test repository"),
Private: github.Ptr(true),
HTMLURL: github.Ptr("https://github.com/testuser/test-repo"),
- CloneURL: github.Ptr("https://github.com/testuser/test-repo.git"),
CreatedAt: &github.Timestamp{Time: time.Now()},
Owner: &github.User{
Login: github.Ptr("testuser"),
@@ -1119,6 +1167,34 @@ func Test_CreateRepository(t *testing.T) {
expectError: false,
expectedRepo: mockRepo,
},
+ {
+ name: "successful repository creation in organization",
+ mockedClient: mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.EndpointPattern{
+ Pattern: "/orgs/testorg/repos",
+ Method: "POST",
+ },
+ expectRequestBody(t, map[string]interface{}{
+ "name": "test-repo",
+ "description": "Test repository",
+ "private": false,
+ "auto_init": true,
+ }).andThen(
+ mockResponse(t, http.StatusCreated, mockRepo),
+ ),
+ ),
+ ),
+ requestArgs: map[string]interface{}{
+ "name": "test-repo",
+ "description": "Test repository",
+ "organization": "testorg",
+ "private": false,
+ "autoInit": true,
+ },
+ expectError: false,
+ expectedRepo: mockRepo,
+ },
{
name: "successful repository creation with minimal parameters",
mockedClient: mock.NewMockedHTTPClient(
@@ -1192,17 +1268,13 @@ func Test_CreateRepository(t *testing.T) {
// Parse the result and get the text content if no error
textContent := getTextResult(t, result)
- // Unmarshal and verify the result
- var returnedRepo github.Repository
+ // Unmarshal and verify the minimal result
+ var returnedRepo MinimalResponse
err = json.Unmarshal([]byte(textContent.Text), &returnedRepo)
assert.NoError(t, err)
// Verify repository details
- assert.Equal(t, *tc.expectedRepo.Name, *returnedRepo.Name)
- assert.Equal(t, *tc.expectedRepo.Description, *returnedRepo.Description)
- assert.Equal(t, *tc.expectedRepo.Private, *returnedRepo.Private)
- assert.Equal(t, *tc.expectedRepo.HTMLURL, *returnedRepo.HTMLURL)
- assert.Equal(t, *tc.expectedRepo.Owner.Login, *returnedRepo.Owner.Login)
+ assert.Equal(t, tc.expectedRepo.GetHTMLURL(), returnedRepo.URL)
})
}
}
@@ -2287,6 +2359,171 @@ func Test_GetLatestRelease(t *testing.T) {
}
}
+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
diff --git a/pkg/github/search.go b/pkg/github/search.go
index 248f17e17..55e4cf8b4 100644
--- a/pkg/github/search.go
+++ b/pkg/github/search.go
@@ -26,6 +26,10 @@ func SearchRepositories(getClient GetClientFn, t translations.TranslationHelperF
mcp.Required(),
mcp.Description("Repository search query. Examples: 'machine learning in:name stars:>1000 language:python', 'topic:react', 'user:facebook'. Supports advanced search syntax for precise filtering."),
),
+ mcp.WithBoolean("minimal_output",
+ mcp.Description("Return minimal repository information (default: true). When false, returns full GitHub API repository objects."),
+ mcp.DefaultBool(true),
+ ),
WithPagination(),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -37,7 +41,10 @@ func SearchRepositories(getClient GetClientFn, t translations.TranslationHelperF
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
-
+ minimalOutput, err := OptionalBoolParamWithDefault(request, "minimal_output", true)
+ if err != nil {
+ return mcp.NewToolResultError(err.Error()), nil
+ }
opts := &github.SearchOptions{
ListOptions: github.ListOptions{
Page: pagination.Page,
@@ -67,9 +74,55 @@ func SearchRepositories(getClient GetClientFn, t translations.TranslationHelperF
return mcp.NewToolResultError(fmt.Sprintf("failed to search repositories: %s", string(body))), nil
}
- r, err := json.Marshal(result)
- if err != nil {
- return nil, fmt.Errorf("failed to marshal response: %w", err)
+ // Return either minimal or full response based on parameter
+ var r []byte
+ if minimalOutput {
+ minimalRepos := make([]MinimalRepository, 0, len(result.Repositories))
+ for _, repo := range result.Repositories {
+ minimalRepo := MinimalRepository{
+ ID: repo.GetID(),
+ Name: repo.GetName(),
+ FullName: repo.GetFullName(),
+ Description: repo.GetDescription(),
+ HTMLURL: repo.GetHTMLURL(),
+ Language: repo.GetLanguage(),
+ Stars: repo.GetStargazersCount(),
+ Forks: repo.GetForksCount(),
+ OpenIssues: repo.GetOpenIssuesCount(),
+ Private: repo.GetPrivate(),
+ Fork: repo.GetFork(),
+ Archived: repo.GetArchived(),
+ DefaultBranch: repo.GetDefaultBranch(),
+ }
+
+ if repo.UpdatedAt != nil {
+ minimalRepo.UpdatedAt = repo.UpdatedAt.Format("2006-01-02T15:04:05Z")
+ }
+ if repo.CreatedAt != nil {
+ minimalRepo.CreatedAt = repo.CreatedAt.Format("2006-01-02T15:04:05Z")
+ }
+ if repo.Topics != nil {
+ minimalRepo.Topics = repo.Topics
+ }
+
+ minimalRepos = append(minimalRepos, minimalRepo)
+ }
+
+ minimalResult := &MinimalSearchRepositoriesResult{
+ TotalCount: result.GetTotal(),
+ IncompleteResults: result.GetIncompleteResults(),
+ Items: minimalRepos,
+ }
+
+ r, err = json.Marshal(minimalResult)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal minimal response: %w", err)
+ }
+ } else {
+ r, err = json.Marshal(result)
+ if err != nil {
+ return nil, fmt.Errorf("failed to marshal full response: %w", err)
+ }
}
return mcp.NewToolResultText(string(r)), nil
@@ -156,21 +209,6 @@ func SearchCode(getClient GetClientFn, t translations.TranslationHelperFunc) (to
}
}
-// MinimalUser is the output type for user and organization search results.
-type MinimalUser struct {
- Login string `json:"login"`
- ID int64 `json:"id,omitempty"`
- ProfileURL string `json:"profile_url,omitempty"`
- AvatarURL string `json:"avatar_url,omitempty"`
- Details *UserDetails `json:"details,omitempty"` // Optional field for additional user details
-}
-
-type MinimalSearchUsersResult struct {
- TotalCount int `json:"total_count"`
- IncompleteResults bool `json:"incomplete_results"`
- Items []MinimalUser `json:"items"`
-}
-
func userOrOrgHandler(accountType string, getClient GetClientFn) server.ToolHandlerFunc {
return func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
query, err := RequiredParam[string](request, "query")
diff --git a/pkg/github/search_test.go b/pkg/github/search_test.go
index cfc87c02b..91ca45af5 100644
--- a/pkg/github/search_test.go
+++ b/pkg/github/search_test.go
@@ -148,23 +148,80 @@ func Test_SearchRepositories(t *testing.T) {
textContent := getTextResult(t, result)
// Unmarshal and verify the result
- var returnedResult github.RepositoriesSearchResult
+ var returnedResult MinimalSearchRepositoriesResult
err = json.Unmarshal([]byte(textContent.Text), &returnedResult)
require.NoError(t, err)
- assert.Equal(t, *tc.expectedResult.Total, *returnedResult.Total)
- assert.Equal(t, *tc.expectedResult.IncompleteResults, *returnedResult.IncompleteResults)
- assert.Len(t, returnedResult.Repositories, len(tc.expectedResult.Repositories))
- for i, repo := range returnedResult.Repositories {
- assert.Equal(t, *tc.expectedResult.Repositories[i].ID, *repo.ID)
- assert.Equal(t, *tc.expectedResult.Repositories[i].Name, *repo.Name)
- assert.Equal(t, *tc.expectedResult.Repositories[i].FullName, *repo.FullName)
- assert.Equal(t, *tc.expectedResult.Repositories[i].HTMLURL, *repo.HTMLURL)
+ assert.Equal(t, *tc.expectedResult.Total, returnedResult.TotalCount)
+ assert.Equal(t, *tc.expectedResult.IncompleteResults, returnedResult.IncompleteResults)
+ assert.Len(t, returnedResult.Items, len(tc.expectedResult.Repositories))
+ for i, repo := range returnedResult.Items {
+ assert.Equal(t, *tc.expectedResult.Repositories[i].ID, repo.ID)
+ assert.Equal(t, *tc.expectedResult.Repositories[i].Name, repo.Name)
+ assert.Equal(t, *tc.expectedResult.Repositories[i].FullName, repo.FullName)
+ assert.Equal(t, *tc.expectedResult.Repositories[i].HTMLURL, repo.HTMLURL)
}
})
}
}
+func Test_SearchRepositories_FullOutput(t *testing.T) {
+ mockSearchResult := &github.RepositoriesSearchResult{
+ Total: github.Ptr(1),
+ IncompleteResults: github.Ptr(false),
+ Repositories: []*github.Repository{
+ {
+ ID: github.Ptr(int64(12345)),
+ Name: github.Ptr("test-repo"),
+ FullName: github.Ptr("owner/test-repo"),
+ HTMLURL: github.Ptr("https://github.com/owner/test-repo"),
+ Description: github.Ptr("Test repository"),
+ StargazersCount: github.Ptr(100),
+ },
+ },
+ }
+
+ mockedClient := mock.NewMockedHTTPClient(
+ mock.WithRequestMatchHandler(
+ mock.GetSearchRepositories,
+ expectQueryParams(t, map[string]string{
+ "q": "golang test",
+ "page": "1",
+ "per_page": "30",
+ }).andThen(
+ mockResponse(t, http.StatusOK, mockSearchResult),
+ ),
+ ),
+ )
+
+ client := github.NewClient(mockedClient)
+ _, handlerTest := SearchRepositories(stubGetClientFn(client), translations.NullTranslationHelper)
+
+ request := createMCPRequest(map[string]interface{}{
+ "query": "golang test",
+ "minimal_output": false,
+ })
+
+ result, err := handlerTest(context.Background(), request)
+
+ require.NoError(t, err)
+ require.False(t, result.IsError)
+
+ textContent := getTextResult(t, result)
+
+ // Unmarshal as full GitHub API response
+ var returnedResult github.RepositoriesSearchResult
+ err = json.Unmarshal([]byte(textContent.Text), &returnedResult)
+ require.NoError(t, err)
+
+ // Verify it's the full API response, not minimal
+ assert.Equal(t, *mockSearchResult.Total, *returnedResult.Total)
+ assert.Equal(t, *mockSearchResult.IncompleteResults, *returnedResult.IncompleteResults)
+ assert.Len(t, returnedResult.Repositories, 1)
+ assert.Equal(t, *mockSearchResult.Repositories[0].ID, *returnedResult.Repositories[0].ID)
+ assert.Equal(t, *mockSearchResult.Repositories[0].Name, *returnedResult.Repositories[0].Name)
+}
+
func Test_SearchCode(t *testing.T) {
// Verify tool definition once
mockClient := github.NewClient(nil)
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/server.go b/pkg/github/server.go
index 80a1bbac6..16d28643c 100644
--- a/pkg/github/server.go
+++ b/pkg/github/server.go
@@ -144,6 +144,21 @@ func OptionalIntParamWithDefault(r mcp.CallToolRequest, p string, d int) (int, e
return v, nil
}
+// OptionalBoolParamWithDefault is a helper function that can be used to fetch a requested parameter from the request
+// similar to optionalBoolParam, but it also takes a default value.
+func OptionalBoolParamWithDefault(r mcp.CallToolRequest, p string, d bool) (bool, error) {
+ args := r.GetArguments()
+ _, ok := args[p]
+ v, err := OptionalParam[bool](r, p)
+ if err != nil {
+ return false, err
+ }
+ if !ok {
+ return d, nil
+ }
+ return v, nil
+}
+
// OptionalStringArrayParam is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request, if not, it returns its zero-value
diff --git a/pkg/github/tools.go b/pkg/github/tools.go
index 3fb39ada7..10a3f3eca 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)
@@ -33,6 +33,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
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)),
@@ -85,7 +86,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
toolsets.NewServerTool(GetPullRequestFiles(getClient, t)),
toolsets.NewServerTool(SearchPullRequests(getClient, t)),
toolsets.NewServerTool(GetPullRequestStatus(getClient, t)),
- toolsets.NewServerTool(GetPullRequestComments(getClient, t)),
+ toolsets.NewServerTool(GetPullRequestReviewComments(getClient, t)),
toolsets.NewServerTool(GetPullRequestReviews(getClient, t)),
toolsets.NewServerTool(GetPullRequestDiff(getClient, t)),
).
@@ -146,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)),
@@ -159,6 +160,14 @@ 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")
@@ -193,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/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 88ee6a838..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,10 +19,11 @@ 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))
@@ -33,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 88ee6a838..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,10 +19,11 @@ 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))
@@ -33,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 bb742aeb0..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,10 +20,11 @@ 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))
@@ -34,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/buger/jsonparser/LICENSE b/third-party/github.com/buger/jsonparser/LICENSE
new file mode 100644
index 000000000..ac25aeb7d
--- /dev/null
+++ b/third-party/github.com/buger/jsonparser/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+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
+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/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.
|