Skip to main content
Glama

export_api_collection

Read-only

Export a collection as an OpenAPI 3.1 or Postman 2.1 document. Handy to read the whole API at once.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "collection_id": "<collection_id>"
    },
    "name": "export_api_collection"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNoopenapi (OpenAPI 3.1, the default) or postman (Postman 2.1).
collection_idYesId from list_api_collections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / collection_id / description
      Added value: +"Id from list_api_collections."
    • addedInput schema / properties / format / description
      Added value: +"openapi (OpenAPI 3.1, the default) or postman (Postman 2.1)."
  2. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered externally. The description adds only the format/serialization context; it says nothing about output size, pagination, or whether all endpoints are guaranteed included, which would matter for large collections.

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

Conciseness4/5

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

Two short sentences, front-loaded with the action and formats. Nothing is redundant or buried, though the second sentence is more sales pitch than spec.

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

Completeness4/5

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

A simple read-only, two-parameter tool with full schema coverage and no output schema; the essentials are present. Only minor gaps remain around output characteristics (size/limits) for very large collections.

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 description coverage is 100% and the format parameter already documents the enum, its default, and the spec versions. The description merely repeats that OpenAPI 3.1 or Postman 2.1 is chosen, adding no syntax or behavior beyond the schema.

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?

States a specific verb (export) and resource (an API collection) plus the two output document formats, so an agent can distinguish it from get_api_collection or list_api_collections. It stops short of explicitly contrasting with those siblings, but the scope is unambiguous.

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?

"Handy to read the whole API at once" gives an implied use case (want a full picture rather than browsing endpoints), but it never says when to prefer this over get_api_collection or when not to use it, and names no alternative.

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.