api-docs-mcp-server
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get-spec-overviewA | 读取 Swagger/OpenAPI 文档,返回 info、servers、tags 分组统计、接口总数等概览信息。通常这是使用其它工具前的第一步。参数 source:文档的 URL(http/https)或本地文件路径(.json/.yaml/.yml),可选,不传时使用服务端配置的默认文档。 |
| search-apisA | 按关键词搜索接口(匹配 path/summary/description/tags/operationId,大小写不敏感),返回 method/path/summary/tags 列表,获取确切 path 后用 get-api-detail 查看详情。参数:source 同上;keyword 搜索关键词(如「充值」「user」,不传返回全部);limit 最多返回条数(默认 50,最大 200)。 |
| get-api-detailA | 按 method + path 返回接口完整详情:参数、请求体、响应结构,所有 $ref 引用(数据模型)已递归展开,循环引用会标记为 $ref-cycle。参数:source 同上;method HTTP 方法(如 GET/POST);path 接口路径,需与文档完全一致(可先用 search-apis 查询)。 |
| get-openapi-specA | 导出完整(或分段)的 OpenAPI 3.x 文档文本,超长自动截断。参数:source 同上;format 输出格式 json/yaml(默认 json);section 导出分段 full/paths/schemas/info(默认 full);max_length 最大返回字符数(默认 50000)。大文档建议用 section 分段获取,或优先使用概览/搜索/详情工具。 |
| refresh-cacheA | 强制重新加载文档源并立即替换缓存(无需等待 5 分钟过期)。参数 source 可选:传了只刷新该文档源(若从未加载过则加载并加入缓存);不传则刷新全部已缓存源(注意:不等于默认文档;若默认文档从未被加载则不在刷新之列)。刷新失败时保留旧缓存。 |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |