MCP

The Kimchi Model Context Protocol (MCP) server connects AI tools to the Kimchi API. Any MCP client can connect. Supported tools include Cursor, VS Code, Windsurf, JetBrains, Claude Desktop, ChatGPT, Kimchi Studio, Claude Code, Gemini CLI, and Codex.

What is MCP?

Model Context Protocol (MCP) is an open standard that allows AI applications to securely access external data sources and tools. Once connected, your AI tool can call:

Kimchi hosts a remote MCP server at:

https://docs.kimchi.dev/mcp

Set up with an agent

Paste this prompt into your AI tool to let it configure the connection:

Set me up with the Kimchi MCP server in this AI tool.

First understand what client you are running in, for example Cursor, Windsurf, Claude Desktop, or Gemini CLI. Then read the setup instructions here: https://docs.kimchi.dev/reference/mcp and follow the section for that client to write the configuration. If the client is not listed, use the server URL and the X-API-Key header documented on that page to write the configuration in the client's native format.

Ask me for my Kimchi API key and wait for my answer. If I do not have a key, send me to https://app.kimchi.dev/settings to create one, then continue.

After setup, list the MCP server's tools to confirm the connection. If the client needs a restart or reload, tell me exactly what to restart and resume this conversation after I restart it. Do not start a new conversation.

Set up manually

Configure your AI development tools to connect to the Kimchi MCP server at:

https://docs.kimchi.dev/mcp

The examples use the X-API-Key header. To use a bearer token instead, see Kimchi API key.

{
  "mcpServers": {
    "kimchi": {
      "url": "https://docs.kimchi.dev/mcp",
      "headers": {
        "X-API-Key": "<your-kimchi-api-key>"
      }
    }
  }
}

Selecting an API server

The Kimchi MCP server URL accepts query parameters that pin the API server and override server variables defined in the Kimchi OpenAPI spec. This gives your AI tool a deterministic target. Your tool connects to exactly the server you specify, not to a server the AI selects at runtime.

URL parameters

Example

The Kimchi API spec defines three servers:

To connect the MCP server to a specific endpoint, select it below:

{
  "mcpServers": {
    "kimchi": {
      "url": "https://docs.kimchi.dev/mcp?server=0",
      "headers": {
        "X-API-Key": "<your-kimchi-api-key>"
      }
    }
  }
}

Append server and server_variables directly to the MCP URL.

Authentication

Connecting to the Kimchi MCP server needs no authentication. The tools need your Kimchi API key when they call the Kimchi API on your behalf. Configure one API key header in your client:

The MCP server forwards this header to the Kimchi API when a tool calls the API on your behalf.

Kimchi API key

You can pass your Kimchi API key in two formats:

Both formats use the same Kimchi API key and provide identical access. Use whichever format your tooling or organization requires.

Obtaining an API key

Generate an API key in the Kimchi console at Kimchi → API Keys. For details, see API Keys and Service Keys.

Testing your MCP setup

Once configured, test your MCP server connection:

1. Open your AI editor, for example Cursor, Windsurf, Gemini CLI, or Kimchi Studio.

2. Start a new chat with the AI assistant.

3. Ask about Kimchi, for example:

   Text

   List the Kimchi API endpoints you can call.

The AI should now have access to the Kimchi API and documentation through the MCP server.

Troubleshooting

If the MCP server is not responding or returning errors, check the MCP server logs for your client before investigating further.

After reviewing logs, also verify that:

• Your API key is valid and has not been deleted or disabled
• The header value in your config does not include extra spaces or line breaks
• X-API-Key (or Authorization) is present in your configuration
• For Claude Desktop, --header values have no space after the colon: use X-API-Key:<key>, not X-API-Key: <key>
• You fully quit and relaunch your AI editor after updating the config file. Most clients do not reload the MCP configuration without a restart

Related resources