Skip to main content
Glama
geniyangge

api-docs-mcp-server

by geniyangge

导出完整 OpenAPI 文档

get-openapi-spec

Fetch OpenAPI 3.x spec in JSON/YAML, optionally extracting sections (paths, schemas, info) and limiting length for large docs.

Instructions

导出完整(或分段)的 OpenAPI 3.x 文档文本,超长自动截断。参数:source 同上;format 输出格式 json/yaml(默认 json);section 导出分段 full/paths/schemas/info(默认 full);max_length 最大返回字符数(默认 50000)。大文档建议用 section 分段获取,或优先使用概览/搜索/详情工具。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNo输出格式,默认 jsonjson
sourceNoSwagger/OpenAPI 文档的 URL(http/https)或本地文件路径(.json/.yaml/.yml);不传时使用服务端配置的默认文档
sectionNo导出分段,默认 fullfull
max_lengthNo最大返回字符数,默认 50000
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description discloses key behavior like auto-truncation ('超长自动截断') and default parameter values. It does not mention permissions or side effects, but for a read-only export this is sufficient.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences pack purpose, parameter list, and usage advice without wasted words. The structure is logical and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers all essential aspects: output format, segmentation, truncation, defaults, and usage guidance. Return values are implied by '文档文本' and no output schema is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value by summarizing parameter defaults and explicitly linking max_length to truncation behavior, though 'source 同上' is vague.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it exports full or segmented OpenAPI 3.x document text, with a specific verb and resource. It distinguishes itself from sibling tools by suggesting overview/search/detail tools for other needs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly advises when to use the section parameter for large documents and directs users to alternative tools (概览/搜索/详情), providing clear when-to-use and when-not-to-use guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/geniyangge/api-docs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server