get_api_collection
Get one collection's folders, endpoints (id, method, path, name, version, example count) and environments (with their variables).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collection_id | Yes |
Get one collection's folders, endpoints (id, method, path, name, version, example count) and environments (with their variables).
| Name | Required | Description | Default |
|---|---|---|---|
| collection_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the operation read-only and non-destructive, so the safety profile is covered. The description adds the contents of the response (folders, endpoint fields, environment variables) but does not disclose response shape, pagination, permissions, or error behavior.
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?
The entire description is a single, front-loaded sentence; every clause adds either the resource, the scope, or the return fields. There is no filler, and the most important verb/resource appear first.
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?
For a simple one-parameter read operation, the description is mostly complete: it names the target and the return contents. It would be improved by stating the relationship to sibling retrieval tools or noting how collection_id is obtained, but the annotations cover the read-only safety aspects.
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?
The input schema has one undocumented collection_id parameter and 0% schema description coverage, so the description should compensate. It only implies the parameter identifies a single collection ('one collection's') and gives no guidance on the ID format, provenance, or how to obtain it.
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?
Description begins with a specific verb ('Get') and a precise resource ('one collection's folders, endpoints... and environments'), and enumerates the attributes returned. This clearly distinguishes it from siblings like list_api_collections (all collections) and get_api_endpoint (a single endpoint).
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 'one collection's' implies the tool is for a single collection rather than listing all, but the description never states when to prefer this tool over list_api_collections, export_api_collection, or get_api_endpoint. No alternatives or exclusions are named, so the agent must infer usage from the resource scope.
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.