Skip to main content
Glama

技术文档生成(按次计费)

docgen

README / API 文档 / 变更日志 / 技术方案一键生成。按次计费:业务成功才确认扣款,内容违规、模型超时或生成失败会自动全额退款。

Input Schema

NameRequiredDescriptionDefault
sourceYes代码或接口说明素材,最多 20000 字符。
docTypeNoreadme=项目说明 / api=接口文档 / changelog=变更日志 / design=技术方案 / onboarding=上手指南。readme
audienceNodeveloper=开发者 / pm=产品 / ops=运维 / enduser=最终用户。developer
requestIdNo幂等键。同一次业务重试时复用同一个值,可避免重复扣费。

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations at all, the description carries the full disclosure burden and does deliver the most consequential behavior: per-call billing, charge only on business success, and full auto-refund on content violation, model timeout or generation failure. It stops short of covering output format, typical latency, or any permission/auth requirements, which keeps it from a 5.

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?

Two sentences: capability first, billing guarantee second. Every clause earns its place and the pricing/refund fact — the highest-risk unknown for an agent — is stated up front rather than buried.

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

Completeness3/5

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

There is no output schema, so the description should say what comes back (markdown text, file, URL) and roughly how long generation takes; it only alludes to timeout. Cost and refund risk are well covered, but for a paid generative tool the return contract is a real gap.

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

Parameters3/5

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

Schema coverage is 100% and every parameter including the docType and audience enums is fully documented in the schema, so the baseline of 3 applies. The description adds no syntax, length, or idempotency detail beyond what the schema already states (including the requestId dedup note).

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

Purpose4/5

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

Names a specific verb (一键生成) and resource (README / API 文档 / 变更日志 / 技术方案), and enumerates concrete output artifacts that map to the docType enum. It doesn't explicitly contrast itself with siblings like codegen or copywriter, but the doc-type list makes the domain clear enough to separate it.

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

Usage Guidelines3/5

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

Usage is only implied through the enumeration of documentation kinds — an agent can infer 'use this when you need README/API/changelog/design docs', but there is no explicit when-not guidance and no reference to the sibling generators (codegen, testgen, copywriter). The billing clause describes consequences, not selection criteria.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.