Files
agent-fox/docs/mcp-tools/list-endpoints.md
2026-04-12 20:15:41 +08:00

1.3 KiB
Raw Permalink Blame History

list_endpoints

列出指定模块中的所有端点摘要信息。

参数

参数 类型 必填 说明
moduleId string 模块 ID可从 get_project_overviewlist_modules 获取

返回结果

[
  {
    "id": "ep_001",
    "method": "POST",
    "path": "/v1/charges",
    "summary": "Create a charge",
    "deprecated": false
  },
  {
    "id": "ep_002",
    "method": "GET",
    "path": "/v1/charges/{id}",
    "summary": "Retrieve a charge",
    "deprecated": false
  },
  {
    "id": "ep_003",
    "method": "POST",
    "path": "/v1/refunds",
    "summary": "Create a refund",
    "deprecated": false
  }
]

返回字段说明

字段 类型 说明
id string 端点 ID用于 get_endpoint_detail
method string HTTP 方法GET、POST、PUT、DELETE 等)
path string API 路径
summary string 端点简短描述
deprecated boolean 是否已弃用

结果按路径字母排序,然后按 HTTP 方法排序。

Token 消耗

200-500 tokens,取决于模块中的端点数量。

使用场景

  • 浏览特定模块中的所有端点
  • 找到目标端点的 ID用于调用 get_endpoint_detail
  • 了解 API 提供了哪些操作