export_api_collection
Export a collection as an OpenAPI 3.1 or Postman 2.1 document. Handy to read the whole API at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | ||
| collection_id | Yes |
Export a collection as an OpenAPI 3.1 or Postman 2.1 document. Handy to read the whole API at once.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | ||
| collection_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that the export is in OpenAPI 3.1 or Postman 2.1 formats, which is useful, but it does not disclose the return type (e.g., string, file, URL) or any constraints like size limits. This is acceptable given the annotations but leaves some behavior unspecified.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler. The core action is front-loaded, and the second sentence adds a lightweight use-case hint. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has only two parameters and no output schema, so the description must clarify what the agent gets back. It states the output is a 'document' but does not specify the format's container (JSON string, file, etc.), nor any branching behavior for the two formats. Given the safety annotations, this is adequate for a simple export but lacks return-value clarity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It adds meaning to the 'format' parameter by mapping enum values to 'OpenAPI 3.1' and 'Postman 2.1'. However, the 'collection_id' parameter is only implied by the tool's name, not explicitly described. This partial compensation is moderate but not thorough.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Export a collection') and the output formats ('OpenAPI 3.1 or Postman 2.1 document'), which distinguishes it from simple retrieval tools like get_api_collection. However, it does not explicitly name a sibling to contrast with, so the differentiation is implied rather than explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'Handy to read the whole API at once' gives an implied use case, but the description does not specify when to use this tool versus alternatives like get_api_collection or import_api_spec. No exclusions or alternative conditions are provided, leaving the situational guidance vague.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.