Skip to main content

MCP Gateway

MCP (Model Context Protocol) Gateway can translate MCP tool callings to traditional HTTP API requests. It can provide a configurable way to get existing HTTP API to MCP territory.

Getting Started

Create config file from config.example.yaml:

$ cp config.example.yaml config.yaml

Edit config.yaml file, map all APIs to MCP tools.

Then start launch it with SSE transport:

$ uv run mcp-gateway
INFO:     Started server process [15400]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:3001 (Press CTRL+C to quit)

Default is 3001.

Server Control

Change Port

Provide parameter --port=<port_no> in command line will change the port to SSE transport.

Launch gateway with port 3002:

$ uv run mcp-gateway --port=3002
INFO:     Started server process [15400]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:3002 (Press CTRL+C to quit)

stdio Transport

Provide parameter --transport=stdio in command line will change the transport to stdio.

E.G.:

$ uv run mcp-gateway --transport=stdio

It's meaningless to manually launch gateway in stdio transport. You can configure in Cursor or Cline like:

{
    "mcpServers": {
        "mcp-gateway": {
          "command": "uv",
          "args": ["run", "mcp-gateway", "--transport=stdio"]
        }
      }
}

Or MCP Inspector with form values:

Item Value
Transport Type STDIO
Command uv
Arguments run mcp-gateway --transport=stdio

Configuration File

There is two parts in configuration YAML, server and tools. server defines the basic info for gateway server use. tools defines the mapping from single MCP tool to HTTP API request.

server:
  name: rest-amap-server
  config:
    apiKey: foo
tools:
- name: maps-geo
  description: "将详细的结构化地址转换为经纬度坐标。支持对地标性名胜景区、建筑物名称解析为经纬度坐标"
  args:
  - name: address
    description: "待解析的结构化地址信息"
    required: true
  - name: city
    description: "指定查询的城市"
    required: false
  requestTemplate:
    url: "https://restapi.amap.com/v3/geocode/geo?key={{.config.apiKey}}&address={{.args.address}}&city={{.args.city}}&source=ts_mcp"
    method: GET
    headers:
    - key: x-api-key
      value: "{{.config.apiKey}}"
    - key: Content-Type
      value: application/json
  responseTemplate:
    body: |
      # 地理编码信息
      {{- range $index, $geo := .Geocodes }}
      ## 地点 {{add $index 1}}

      - **国家**: {{ $geo.Country }}
      - **省份**: {{ $geo.Province }}
      - **城市**: {{ $geo.City }}
      - **城市代码**: {{ $geo.Citycode }}
      - **区/县**: {{ $geo.District }}
      - **街道**: {{ $geo.Street }}
      - **门牌号**: {{ $geo.Number }}
      - **行政编码**: {{ $geo.Adcode }}
      - **坐标**: {{ $geo.Location }}
      - **级别**: {{ $geo.Level }}
      {{- end }}

Server

Item Description
name Server name
config Key/Value pairs that can be referenced by var {{.config.xxx}} in templates

Tools

tools is list of MCP tools mapping. Single tool props. are defined as follows:

Item Description
name Tool name (Function name), which is provided to LLM.
description Tool description through which LLM can understand what the tool could do.
args Arguments of tool (Function arguments).
requestTemplate Request mapping to target HTTP API.
responseTemplate Response mapping for response of target HTTP API.

Single argument props. are defined as follows:

Item Type Description
name Argument name, which is provided to LLM.
description Argument description through which LLM can understand and decide what value should be filled.
required Boolean Required argument or not.

Request template props. are defined as follows:

Item Description
method HTTP method
url Target HTTP API url template
headers HTTP headers

HTTP headers are defined as follows:

Item Description
key Header key
value Header value template

Response template props are defined as follows:

Item Description
body Response body template

Contribution

All kinds of contribution are welcomed.

Metadata

Release files for iflow-mcp-superhero_api 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iflow-mcp-superhero_api 0.2.0
File Size Uploaded
iflow_mcp_superhero_api-0.2.0.tar.gz 11.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iflow-mcp-superhero_api 0.2.0
File Interpreter ABI Platform
iflow_mcp_superhero_api-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 24.3 kB

Release files / iflow_mcp_superhero_api-0.2.0.tar.gz

Download URL iflow_mcp_superhero_api-0.2.0.tar.gz
Size 11.2 kB
Tags Source
SHA-256 checksum
How to use checksums
557a229c6f40baa7c673fd22c74a0545f4bc38a6bdcb414a0c7483d5480763fc
BLAKE2b-256 checksum
How to use checksums
3e9363dd71049908ee623d34a07c7b68634f7e0022c8af36da931432977efb27
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.17

Release files / iflow_mcp_superhero_api-0.2.0-py3-none-any.whl

Download URL iflow_mcp_superhero_api-0.2.0-py3-none-any.whl
Size 13.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5fc717b572352cdfc6ee25bb6f31c9544e22bc6a21fb350e5a90824a6866c058
BLAKE2b-256 checksum
How to use checksums
2f4e6f4668f39c3030e7066a73ea4b4fe8618ddc7e19eb8e3532bb2fb036b8e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.17

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page