pylon_get_collection

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

With no annotations provided, the description carries the full burden. It states the core read-only behavior ('Get'), which implies non-mutating, but it does not disclose return format, error behavior, or authentication requirements. For a simple GET, this is minimally adequate but lacks rich behavioral context.

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 description is a single, concise sentence with no wasted words. Every word contributes to the meaning, and it is front-loaded with the primary action.

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 retrieval tool with only two parameters and no output schema, the description is largely complete. It clearly states what the tool does and the required context. It lacks return value details, but for a get operation this is often self-evident and not critical for tool selection or invocation.

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 100%, and the tool description adds no new meaning beyond paraphrasing the parameters. The description mentions 'by its ID' and 'within a knowledge base', which aligns with collection_id and knowledge_base_id, but does not enrich the parameter semantics beyond what the schema already provides.

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 (Get), the resource (a specific collection), and the scope (by ID within a knowledge base). It unambiguously differentiates from sibling tools like list_collections, which retrieves all collections, and create_collection.

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 description implies usage when you have a collection ID and knowledge base ID, but it does not explicitly state when to use it over alternatives like list_collections, nor does it mention any exclusions. The context is clear but no explicit guidance on alternative tools.

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