npm package: @stainless-api/github-internal-mcp
Description: The official MCP Server for the GitHub API
Author: GitHub
Latest version: 0.23.0

# GitHub TypeScript MCP Server

It is generated with [Stainless](https://www.stainless.com/).

## Installation

### Direct invocation

You can run the MCP Server directly via `npx`:

```sh
export GITHUB_AUTH_TOKEN="My Auth Token"
export GITHUB_OWNER="My Owner"
export GITHUB_REPO="My Repo"
export GITHUB_WEBHOOK_SECRET="My Webhook Secret"
npx -y @stainless-api/github-internal-mcp@latest
```

### Via MCP Client

There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already
have a client, consult their documentation to install the MCP server.

For clients with a configuration JSON, it might look something like this:

```json
{
  "mcpServers": {
    "stainless_api_github_internal_api": {
      "command": "npx",
      "args": ["-y", "@stainless-api/github-internal-mcp"],
      "env": {
        "GITHUB_AUTH_TOKEN": "My Auth Token",
        "GITHUB_OWNER": "My Owner",
        "GITHUB_REPO": "My Repo",
        "GITHUB_WEBHOOK_SECRET": "My Webhook Secret"
      }
    }
  }
}
```

### Cursor

If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables
in Cursor's `mcp.json`, which can be found in Cursor Settings > Tools & MCP > New MCP Server.

[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40stainless-api%2Fgithub-internal-mcp&config=eyJuYW1lIjoiQHN0YWlubGVzcy1hcGkvZ2l0aHViLWludGVybmFsLW1jcCIsInRyYW5zcG9ydCI6InNzZSIsInVybCI6Imh0dHBzOi8vZ2l0aHViLWludGVybmFsLnN0bG1jcC5jb20vc3NlIiwiZW52Ijp7IkdJVEhVQl9BVVRIX1RPS0VOIjoiU2V0IHlvdXIgR0lUSFVCX0FVVEhfVE9LRU4gaGVyZS4iLCJHSVRIVUJfT1dORVIiOiJTZXQgeW91ciBHSVRIVUJfT1dORVIgaGVyZS4iLCJHSVRIVUJfUkVQTyI6IlNldCB5b3VyIEdJVEhVQl9SRVBPIGhlcmUuIiwiR0lUSFVCX1dFQkhPT0tfU0VDUkVUIjoiU2V0IHlvdXIgR0lUSFVCX1dFQkhPT0tfU0VDUkVUIGhlcmUuIn19)

### VS Code

If you use MCP, you can install the MCP server by clicking the link below. You will need to set your environment variables
in VS Code's `mcp.json`, which can be found via Command Palette > MCP: Open User Configuration.

[Open VS Code](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40stainless-api%2Fgithub-internal-mcp%22%2C%22type%22%3A%22sse%22%2C%22url%22%3A%22https%3A%2F%2Fgithub-internal.stlmcp.com%2Fsse%22%2C%22env%22%3A%7B%22GITHUB_AUTH_TOKEN%22%3A%22Set%20your%20GITHUB_AUTH_TOKEN%20here.%22%2C%22GITHUB_OWNER%22%3A%22Set%20your%20GITHUB_OWNER%20here.%22%2C%22GITHUB_REPO%22%3A%22Set%20your%20GITHUB_REPO%20here.%22%2C%22GITHUB_WEBHOOK_SECRET%22%3A%22Set%20your%20GITHUB_WEBHOOK_SECRET%20here.%22%7D%7D)

### Claude Code

If you use Claude Code, you can install the MCP server by running the command below in your terminal. You will need to set your
environment variables in Claude Code's `.claude.json`, which can be found in your home directory.

```
claude mcp add stainless_api_github_internal_mcp_api --env GITHUB_AUTH_TOKEN="Your GITHUB_AUTH_TOKEN here." GITHUB_OWNER="Your GITHUB_OWNER here." GITHUB_REPO="Your GITHUB_REPO here." GITHUB_WEBHOOK_SECRET="Your GITHUB_WEBHOOK_SECRET here." --transport sse https://github-internal.stlmcp.com/sse
```

## Code Mode

This MCP server is built on the "Code Mode" tool scheme. In this MCP Server,
your agent will write code against the TypeScript SDK, which will then be executed in an
isolated sandbox. To accomplish this, the server will expose two tools to your agent:

- The first tool is a docs search tool, which can be used to generically query for
  documentation about your API/SDK.

- The second tool is a code tool, where the agent can write code against the TypeScript SDK.
  The code will be executed in a sandbox environment without web or filesystem access. Then,
  anything the code returns or prints will be returned to the agent as the result of the
  tool call.

Using this scheme, agents are capable of performing very complex tasks deterministically
and repeatably.

## Running remotely

Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket.

Authorization can be provided via the `Authorization` header using the Bearer scheme.

Additionally, authorization can be provided via the following headers:
| Header | Equivalent client option | Security scheme |
| --------------------- | ------------------------ | --------------- |
| `x-github-auth-token` | `authToken` | BearerAuth |

A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`:

```json
{
  "mcpServers": {
    "stainless_api_github_internal_api": {
      "url": "http://localhost:3000",
      "headers": {
        "Authorization": "Bearer <auth value>"
      }
    }
  }
}
```