Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
- **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
- **[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for OpenAI Codex
- **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
- **[Kiro](/docs/installation-guides/install-kiro.md)** - Installation guide for Kiro
- **[OpenCode](/docs/installation-guides/install-opencode.md)** - Installation guide for the OpenCode terminal agent
- **[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
- **[Zed](/docs/installation-guides/install-zed.md)** - Installation guide for Zed editor
Expand Down Expand Up @@ -391,6 +392,7 @@ 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
- **[Kiro](docs/installation-guides/install-kiro.md)** - Installation guide for Kiro
- **[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[OpenCode](docs/installation-guides/install-opencode.md)** - Installation guide for the OpenCode terminal agent
- **[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
Expand Down
2 changes: 2 additions & 0 deletions docs/installation-guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
- **[Cline](install-cline.md)** - Installation guide for Cline
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
- **[Kiro](install-kiro.md)** - Installation guide for Kiro
- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
- **[OpenCode](install-opencode.md)** - Installation guide for the OpenCode terminal agent
Expand All @@ -30,6 +31,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
| Claude Desktop | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Moderate |
| Cline | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Cursor | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Kiro | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Google Gemini CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| OpenCode | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
| Roo Code | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
Expand Down
108 changes: 108 additions & 0 deletions docs/installation-guides/install-kiro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Install GitHub MCP Server in Kiro

## Prerequisites

1. [Kiro](https://kiro.dev) 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)

[![Add to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=github&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D)

Uses GitHub's hosted server at https://api.githubcopilot.com/mcp/. Clicking the install button opens a confirmation dialog in Kiro that shows the server name, URL, and full config before anything is written. The GitHub server currently requires a Personal Access Token, so add the `Authorization` header shown below after installing.

### Install steps

1. Click the install button above and confirm in the dialog, or open your MCP config file (see [Configuration Files](#configuration-files)) and enter the code block below.
2. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens).
3. Save the file. Kiro reconnects the server automatically.

### Streamable HTTP Configuration

```json
{
"mcpServers": {
"github": {
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer YOUR_GITHUB_PAT"
}
}
}
}
```

## Local Server Setup

The local GitHub MCP server runs via Docker and requires Docker Desktop to be installed and running.

### Install steps

1. Open your MCP config file (see [Configuration Files](#configuration-files)) and enter the code block below.
2. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens).
3. Save the file. Kiro reconnects the server automatically.

### Docker Configuration

```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"
}
}
}
}
```

> **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.

## Configuration Files

Kiro reads MCP servers from two locations (see the [Kiro MCP documentation](https://kiro.dev/docs/mcp/)):

- **Workspace (this project only)**: `.kiro/settings/mcp.json` in the project root
- **User (all projects)**: `~/.kiro/settings/mcp.json`

Open either from the command palette: **Kiro: Open workspace MCP config (JSON)** or **Kiro: Open user MCP config (JSON)**.

## Verify Installation

1. Open the Kiro panel and check the MCP servers tab for a connected "github" server.
2. In chat, check the available tools.
3. Test with: "List my GitHub repositories".

## Troubleshooting

### Remote Server Issues

- **Authentication failures**: Verify your PAT has the correct scopes and has not expired.
- **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**: Check the MCP servers tab in the Kiro panel for the server status and error messages (Output tab → "Kiro - MCP Logs").
- **Invalid JSON**: Validate that the JSON format is correct.

## Important Notes

- **Docker image**: `ghcr.io/github/github-mcp-server` (official and supported)
- **npm package**: `@modelcontextprotocol/server-github` (deprecated as of April 2025 - no longer functional)
- **Kiro specifics**: Supports both workspace and user configurations, uses the `mcpServers` key, and supports remote HTTP MCP servers.