Github Security MCP Server

🚀 GitHub Tool's MCP Server

This repository contains a Model Context Protocol (MCP) server implementation that provides tools for interacting with GitHub. The server is built with TypeScript and the MCP SDK and can be integrated with MCP clients such as GitHub Copilot in Visual Studio Code.

🚀 Quick Start

Prerequisites

• Node.js
• npm (included with Node.js)
• Installed and authenticated GitHub CLI (gh)

Authentication

This MCP server uses the GitHub CLI to obtain a token for the currently authenticated user for authentication purposes.

Running Locally

Starting the Server

npm start

For development, automatically rebuild on file changes:

npm run dev

For debugging and inspecting the server:

npm run inspect

VS Code Integration

Running the Latest Published Version

To use the latest published version, you can choose to add a new tool, select Command (stdio) and use the command npx @rickardhf/github-security-mcp-server.

If you only want to change the mcp.json configuration file of the project, you can use the following configuration:

{
    "servers": {
        "my-local-mcp-server": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "@rickardhf/github-security-mcp-server"
            ]
        }
    },
    ...
}

Running the Local Version

To use the local version in your project, you can run the built file of the project. You can add the following configuration to the mcp.json file, either globally or for a specific workspace.

{
    "servers": {
        "my-local-mcp-server": {
            "type": "stdio",
            "command": "node",
            "args": [
                "c:\\repos\\private\\mcptest\\dist\\index.js"
            ]
        }
    }
}

If running the local version, you can use the following command:

npm run build && npm start

✨ Features

The current tools provided by the server include:

• GitHub User Information: Retrieve detailed information about a GitHub user by username.
• Security Issue Creation: Create security issues with proper formatting and labels in a GitHub repository.
• List Security Issues: List all security-related issues in a GitHub repository.
• Security Status Report: Obtain comprehensive security alerts, including Dependabot, code scanning, and secret scanning.
• Branch Management: List and create branches in a GitHub repository.
• Pull Request Management:
  • Create a pull request between two branches.
  • List all pull requests in a specific repository, including basic information such as number, title, and description.
  • Get detailed information about a specific pull request, including diffs and comments.

📚 Documentation

Project Structure

• src/index.ts: Main entry point and server configuration.
• src/common/: Shared utilities and type definitions.
  • utils.ts: Shared utility functions (GitHub token retrieval).
  • types.ts: TypeScript type definitions.
• src/operations/: Tool implementations.
  • process.ts: Tool registration and mapping.
  • security.ts: Security status report functionality.
  • api/: GitHub API operations.
    • branch.ts: Branch management operations.
    • issues.ts: Security issue operations.
    • pull-requests.ts: Pull request operations.
    • repo.ts: Repository operations.