close

Get MCP Server

Fetch one MCP server by identifier. Request-header values and OAuth client secrets are never returned.

GET/api/v2/mcp-servers/{id}
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

id*string

Unique MCP server identifier.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the MCP server.

Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/mcp-servers/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "mcp-3f7a9c21",
    "name": "Docs server",
    "description": "Internal documentation tools",
    "transport": "streamable-http",
    "authType": "headers",
    "url": "https://mcp.example.com/sse",
    "timeout": 30000,
    "retries": 3,
    "enabled": true,
    "connectionStatus": "connected",
    "lastError": null,
    "toolCount": 7,
    "lastToolsRefresh": "2026-06-20T14:02:11.000Z",
    "lastConnected": "2026-06-20T14:02:11.000Z",
    "createdAt": "2026-06-01T09:14:00.000Z",
    "updatedAt": "2026-06-20T14:02:11.000Z",
    "hasHeaders": true,
    "headerNames": [
      "Authorization"
    ],
    "hasOauthClientSecret": false
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}