get_custom_connector

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

No annotations are provided, so the description carries the full burden. It clearly indicates a read operation ('Get metadata'), implying no destructive side effects. However, it does not disclose potential error behaviors, permission requirements, or the structure of the returned metadata, which would be useful given the absence of an output schema.

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?

A single, concise sentence that directly states the tool's function with no filler. The key scoping ('by id') is front-loaded, making the purpose immediately clear.

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 parameterized get operation, the description covers the core purpose. However, without an output schema or annotations, the agent has no guidance on what the returned metadata contains or what happens if the id does not exist. This is a moderate gap for a tool that must be invoked autonomously.

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 explain the 'id' parameter. It does so by stating the operation is 'by id', which tells the agent that the parameter identifies the target connector. However, it provides no additional context such as where to find the ID or what values are valid, beyond the integer type already in the schema.

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 uses a specific verb ('Get') and resource ('metadata of a custom connector') with a clear scope ('by id'). It unambiguously distinguishes this tool from siblings like list_custom_connectors and get_custom_connector_code, which are related but different operations.

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 that this tool should be used when fetching metadata for a single custom connector by its identifier, but it does not explicitly state when to choose this over get_custom_connector_code or list_custom_connectors. The usage context is clear enough, but no alternatives or exclusions are mentioned.

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