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

1.1 KiB
Raw Blame History

get_project_overview

获取项目的基本信息和模块摘要。这是推荐的第一个调用工具。

参数

无参数。

返回结果

{
  "name": "Stripe API",
  "description": "The Stripe REST API",
  "version": "3.0.0",
  "baseUrl": "https://api.stripe.com",
  "totalEndpoints": 247,
  "modules": [
    {
      "id": "mod_abc123",
      "name": "Payments",
      "endpointCount": 15
    },
    {
      "id": "mod_def456",
      "name": "Customers",
      "endpointCount": 8
    }
  ]
}

返回字段说明

字段 类型 说明
name string 项目名称(来自 OpenAPI 的 info.title
description string 项目描述
version string OpenAPI 规范版本
baseUrl string | null API 基础 URL
totalEndpoints number 端点总数
modules array 模块列表(含 id、名称和端点数量

Token 消耗

200 tokens,是最轻量的工具。

使用场景

  • 初次连接时了解 API 的整体结构
  • 查看有哪些模块可供探索
  • 获取模块 ID 以供后续调用 list_endpoints