服务器

​

获取所有服务器

• 端点: /api/servers
• 方法: GET
• 响应:
  {
    "success": true,
    "data": [
      {
        "name": "example-server",
        "status": "connected",
        "tools": [
          {
            "name": "tool1",
            "description": "工具1的描述"
          }
        ],
        "config": {
          "type": "stdio",
          "command": "node",
          "args": ["server.js"]
        }
      }
    ]
  }
  

​

创建一个新服务器

• 端点: /api/servers
• 方法: POST
• 正文:
  {
    "name": "my-new-server",
    "config": {
      "type": "stdio",
      "command": "python",
      "args": ["-u", "my_script.py"],
      "owner": "admin"
    }
  }
  
  • name (string, 必填): 服务器的唯一名称。
  • config (object, 必填): 服务器配置对象。
    • type (string): stdio、sse、streamable-http 或 openapi。
    • command (string): stdio 类型要执行的命令。
    • args (array of strings): 命令的参数。
    • url (string): sse、streamable-http 或 openapi 类型的 URL。
    • openapi (object): OpenAPI 配置。
      • url (string): OpenAPI 模式的 URL。
      • schema (object): OpenAPI 模式对象本身。
    • headers (object): sse、streamable-http 和 openapi 类型请求要发送的标头。
    • keepAliveInterval (number): 远端服务健康检查的间隔（毫秒）。默认为 60000。
    • enableKeepAlive (boolean): 是否为远端服务启用周期性健康检查。已断连的远端服务始终会通过有上限的指数退避和随机抖动自动重连。
    • owner (string): 服务器的所有者。默认为当前用户或“admin”。

​

更新一个服务器

• 端点: /api/servers/:name
• 方法: PUT
• 参数:
  • :name (string, 必填): 要更新的服务器的名称。
• 正文:
  {
    "config": {
      "type": "stdio",
      "command": "node",
      "args": ["new_server.js"]
    }
  }
  
  • config (object, 必填): 更新后的服务器配置对象。详情请参阅“创建一个新服务器”。

​

删除一个服务器

• 端点: /api/servers/:name
• 方法: DELETE
• 参数:
  • :name (string, 必填): 要删除的服务器的名称。

​

切换一个服务器

• 端点: /api/servers/:name/toggle
• 方法: POST
• 参数:
  • :name (string, 必填): 要切换的服务器的名称。
• 正文:
  {
    "enabled": true
  }
  
  • enabled (boolean, 必填): true 启用服务器，false 禁用服务器。

​

批量设置工具状态

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

• enabled 必须是布尔值；重复请求设置相同状态。
• tools 包含 1–100 个非空名称或模式，每项最多 256 个字符。模式区分大小写并匹配完整名称：* 匹配零个或多个字符，? 匹配一个字符，其他字符均按字面匹配。
• 精确名称优先解析带服务器前缀的运行时名称，其次解析上游原始名称。模式可匹配这两种形式，前缀使用当前配置的名称分隔符。
• 匹配项去重后一次保存，保留描述和隐藏参数。变更影响所有分组，无需重新连接即对工具发现和后续调用生效。
• 个人 OAuth 或个人凭据绑定服务器使用当前认证用户的工具清单，不会借用其他用户的凭据。无法获取该清单时返回 409，不修改工具状态。
• 模式只针对当前清单展开一次，不会保存为约束未来工具的策略。工具清单不可用时返回 409；没有匹配项时成功返回且不写入配置。

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

​

切换一个工具

• 端点: /api/servers/:serverName/tools/:toolName/toggle
• 方法: POST
• 参数:
  • :serverName (string, 必填): 服务器的名称。
  • :toolName (string, 必填): 工具的名称。
• 正文:
  {
    "enabled": true
  }
  
  • enabled (boolean, 必填): true 启用工具，false 禁用工具。

​

更新工具描述

• 端点: /api/servers/:serverName/tools/:toolName/description
• 方法: PUT
• 参数:
  • :serverName (string, 必填): 服务器的名称。
  • :toolName (string, 必填): 工具的名称。
• 正文:
  {
    "description": "新的工具描述"
  }
  
  • description (string, 必填): 工具的新描述。

​

隐藏工具参数

• 端点: /api/servers/:serverName/tools/:toolName/hidden-params
• 方法: PUT
• 参数:
  • :serverName (string, 必填): 服务器的名称。
  • :toolName (string, 必填): 工具的名称，可带或不带服务器前缀。
• 正文:
  {
    "hiddenParams": ["profile", "zeroDataRetention"]
  }
  
  • hiddenParams (string[], 必填): 顶层参数名。空数组表示移除该设置。
• 错误: 参数名不属于该工具或列在其 required 中时返回 400。这些检查在服务器已连接时进行；否则按原样保存，且必填参数始终不会被隐藏。

​

更新系统配置

• 端点: /api/system-config
• 方法: PUT
• 正文:
  {
    "openaiApiKey": "sk-...",
    "openaiBaseUrl": "https://api.openai.com/v1",
    "modelName": "gpt-4",
    "temperature": 0.7,
    "maxTokens": 2048
  }
  
  • 所有字段都是可选的。只有提供的字段会被更新。

​

获取设置

• 端点: /api/settings
• 方法: GET
• 响应:
  {
    "success": true,
    "data": {
      "servers": [...],
      "groups": [...],
      "systemConfig": {...}
    }
  }