Servers

​

Get All Servers

• Endpoint: /api/servers
• Method: GET
• Response:
  {
    "success": true,
    "data": [
      {
        "name": "example-server",
        "status": "connected",
        "tools": [
          {
            "name": "tool1",
            "description": "Description of tool 1"
          }
        ],
        "config": {
          "type": "stdio",
          "command": "node",
          "args": ["server.js"]
        }
      }
    ]
  }
  

​

Get a Server

• Endpoint: GET /api/servers/:name
• Authentication: Required.
• Returns 404 if the server is not configured.

​

Create a New Server

• Endpoint: /api/servers
• Method: POST
• Body:
  {
    "name": "my-new-server",
    "config": {
      "type": "stdio",
      "command": "python",
      "args": ["-u", "my_script.py"],
      "owner": "admin"
    }
  }
  
  • name (string, required): The unique name for the server.
  • config (object, required): The server configuration object.
    • type (string): stdio, sse, streamable-http, or openapi.
    • command (string): Command to execute for stdio type.
    • args (array of strings): Arguments for the command.
    • url (string): URL for sse, streamable-http, or openapi types.
    • openapi (object): OpenAPI configuration.
      • url (string): URL to the OpenAPI schema.
      • schema (object): The OpenAPI schema object itself.
    • headers (object): Headers to send with requests for sse, streamable-http, and openapi types.
    • keepAliveInterval (number): Health check interval in milliseconds for remote servers. Defaults to 60000.
    • enableKeepAlive (boolean): Toggle periodic health checks for remote servers. Disconnected remote servers always retry automatically with bounded exponential backoff and jitter.
    • enabled (boolean): Defaults to true. Disabled servers stay in the configuration but are not connected.
    • owner (string): The owner of the server. Defaults to the current user or 'admin'.
    • passthroughHeaders (string[]): Inbound HTTP header names that should be forwarded to the upstream server.
    • oauth, proxy, options, description: Optional advanced settings — see MCP Settings.

​

Batch Create Servers

• Endpoint: POST /api/servers/batch
• Authentication: Required.
• Body:
  {
    "servers": [
      { "name": "fetch", "config": { "type": "stdio", "command": "uvx", "args": ["mcp-server-fetch"] } },
      { "name": "amap", "config": { "type": "sse", "url": "https://mcp.amap.com/sse?key=..." } }
    ]
  }
  

​

Update a Server

• Endpoint: /api/servers/:name
• Method: PUT
• Parameters:
  • :name (string, required): The name of the server to update.
• Body:
  {
    "config": {
      "type": "stdio",
      "command": "node",
      "args": ["new_server.js"]
    }
  }
  
  • config (object, required): The updated server configuration object. See “Create a New Server” for details.

​

Delete a Server

• Endpoint: /api/servers/:name
• Method: DELETE
• Parameters:
  • :name (string, required): The name of the server to delete.

​

Toggle a Server

• Endpoint: /api/servers/:name/toggle
• Method: POST
• Parameters:
  • :name (string, required): The name of the server to toggle.
• Body:
  {
    "enabled": true
  }
  
  • enabled (boolean, required): true to enable the server, false to disable it.

​

Reload a Server

• Endpoint: POST /api/servers/:name/reload
• Authentication: Required.

​

Batch Tool Status

{
  "enabled": false,
  "tools": ["create_*", "delete_*", "specific_tool"]
}

• enabled is a required boolean; repeated requests set the same state.
• tools contains 1–100 non-empty names or patterns, up to 256 characters each. Patterns are case-sensitive full-name matches: * matches zero or more characters, ? matches one; every other character is literal.
• Exact names resolve runtime (server-prefixed) names first, then original upstream names. Patterns match either form using the configured name separator.
• Matching tools are deduplicated and saved in one update. Descriptions and hidden parameters are preserved. The change applies across groups and takes effect for discovery and subsequent calls without reconnecting.
• For personal OAuth or credential bindings, the inventory belongs to the authenticated caller; another user’s credentials are never borrowed. If that inventory cannot be acquired, the request returns 409 without changing tool states.
• Patterns are expanded once against the current inventory, not persisted as policies for future tools. An unavailable inventory returns 409; an empty match succeeds without writing.

{
  "success": true,
  "data": {
    "matchedTools": ["example-create_item", "example-delete_item"],
    "enabled": false
  }
}

​

Toggle a Tool

• Endpoint: /api/servers/:serverName/tools/:toolName/toggle
• Method: POST
• Parameters:
  • :serverName (string, required): The name of the server.
  • :toolName (string, required): The name of the tool.
• Body:
  {
    "enabled": true
  }
  
  • enabled (boolean, required): true to enable the tool, false to disable it.

​

Update Tool Description

• Endpoint: /api/servers/:serverName/tools/:toolName/description
• Method: PUT
• Parameters:
  • :serverName (string, required): The name of the server.
  • :toolName (string, required): The name of the tool.
• Body:
  {
    "description": "New tool description"
  }
  
  • description (string, required): The new description for the tool.

​

Reset Tool Description

• Endpoint: DELETE /api/servers/:serverName/tools/:toolName/description
• Authentication: Required.

​

Hide Tool Parameters

• Endpoint: /api/servers/:serverName/tools/:toolName/hidden-params
• Method: PUT
• Parameters:
  • :serverName (string, required): The name of the server.
  • :toolName (string, required): The name of the tool, bare or server-prefixed.
• Body:
  {
    "hiddenParams": ["profile", "zeroDataRetention"]
  }
  
  • hiddenParams (string[], required): Top-level parameter names. An empty array removes the setting.
• Errors: 400 when a name is not a parameter of the tool or is listed in its required. These checks run when the server is connected; otherwise the list is stored as given, and a required parameter is still never hidden.

​

Prompts

​

Resources

​

System Configuration

​

Get Settings

• Endpoint: /api/settings
• Method: GET
• Response:
  {
    "success": true,
    "data": {
      "servers": [...],
      "groups": [...],
      "systemConfig": {...}
    }
  }
  

​

Other server-adjacent endpoints