Skip to main content

API Reference

MCP Gatekeeper provides a RESTful API and WebSocket endpoints for managing MCP servers.

Base URL​

http://127.0.0.1:8000/api

Authentication​

All protected endpoints require the X-MCPGK-Token header:

X-MCPGK-Token: your-token-here

Default token: dev-token-change-in-production

See Authentication for details.

API Endpoints​

STDIO Servers​

  • GET /api/servers - List servers
  • POST /api/servers - Add server
  • GET /api/servers/{id} - Get server details
  • DELETE /api/servers/{id} - Delete server
  • GET /api/servers/{id}/tools - List tools

See Servers API

HTTP Servers​

  • GET /api/http-servers - List HTTP servers
  • POST /api/http-servers - Add HTTP server
  • PUT /api/http-servers/{id} - Update server
  • DELETE /api/http-servers/{id} - Delete server
  • POST /api/http-servers/{id}/test - Test connection

Agents​

  • GET /api/agents - List agents
  • GET /api/agents/{agent_type} - Get agent config
  • PUT /api/agents/{agent_type}/servers - Update servers
  • GET /api/agents/{agent_type}/http-servers - Add HTTP server to agent

See Agents API

Packages​

  • GET /api/packages - List installed packages
  • POST /api/packages/install-npm - Install npm package
  • DELETE /api/packages/{name} - Uninstall package
  • POST /api/packages/search - Search npm registry

See Packages API

Metrics​

  • GET /api/metrics/summary - Get metrics summary
  • POST /api/metrics/record - Record metric (internal)
  • GET /api/http-servers/{id}/metrics - HTTP server metrics

See Metrics API

Logs​

  • GET /api/logs - Get logs with filtering
  • GET /api/logs/download - Download logs

See Logs API

WebSocket​

  • WS /api/ws/metrics - Real-time metrics stream

See WebSocket API

Interactive Documentation​

When the backend is running, visit:

http://127.0.0.1:8000/docs

For Swagger UI with interactive API testing.