MCP Link Documentation

To install MCP Link locally, clone the repository and download the Go dependencies.

# Clone repository
git clone https://github.com/automation-ai-labs/mcp-link.git
cd mcp-openapi-to-mcp-adapter

# Install dependencies
go mod download

Start the MCP Link server using go run. You can specify the port and host using the serve command.

# Specify port
go run main.go serve --port 8080 --host 0.0.0.0

To use a converted API in an AI Agent, add the MCP server configuration to your agent's configuration file. The url must point to the SSE endpoint with the appropriate conversion parameters appended as query strings.

{
  "mcpServers": {
    "@service-name": {
      "url": "http://localhost:8080/sse?s=[OpenAPI-Spec-URL]&u=[API-Base-URL]&h=[Auth-Header]:[Value-Prefix]"
    }
  }
}

MCP Link uses query parameters to define how an OpenAPI API is converted into an MCP server. When accessing the SSE endpoint, use the following parameters:

• s=: The URL of the OpenAPI specification file.
• u=: The Base URL of the target API.
• h=: The authentication header format, provided as header-name:value-prefix (e.g., Authorization:Bearer ).
• f=: Path filter expressions to include or exclude specific API endpoints.

The f= parameter allows you to control which API endpoints are exposed to the MCP server using path filter expressions.

Syntax Rules:

• +/path/**: Include all endpoints under /path/.
• -/path/**: Exclude all endpoints under /path/.
• +/users/*:GET: Include only GET endpoints for /users/{id}.
• Wildcards: * matches any single path segment; ** matches zero or more segments.
• Separation: Multiple filters are separated by semicolons (e.g., +/**:GET;-/internal/**).

The serve command accepts the following flags to configure the server's network interface:

--port, -p (int)
    Port to listen on (default: 8080)

--host, -H (string)
    Host to listen on (default: localhost)

The mcp-link CLI provides a serve command to start the MCP Link server, which converts OpenAPI endpoints into MCP-compatible endpoints. By default, it listens on localhost:8080.

# Start the server with default settings (localhost:8080)
mcp-link serve

# Start the server on a specific host and port
mcp-link serve --host 0.0.0.0 --port 9000

# Using aliases
mcp-link serve -H 0.0.0.0 -p 9000