List Talk endpoints

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

The readOnlyHint annotation already declares that this is a read-only operation, and the description's word 'Catalog' reinforces a non-mutating reference role. However, the description does not add meaningful behavioral detail beyond the annotation, such as return shape, pagination, or side-effect caveats.

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 two sentences with no filler. The first sentence immediately states what the tool is, and the second sentence gives actionable guidance on how to use the result, front-loading the most important information.

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 optional-filter catalog tool, the description is largely complete: it conveys the tool's scope, content, and relationship to sibling tools, while the schema covers the filter parameter. The absence of an explicit output shape description is a minor gap, but not enough to make the tool hard to invoke correctly.

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 single optional 'area' parameter has an enum with a description in the schema, so the description does not need to explain parameters. The text focuses on the tool's purpose rather than adding new meaning to the parameter.

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 and resource: it is a 'Catalog of known UniFi Talk API endpoints' with their parameters, and it explicitly frames the tool as a lookup aid for talk_get or talk_invoke. This clearly distinguishes it from sibling tools that list or invoke specific resources.

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 gives clear context by saying 'Use it to find an endpoint id for talk_get or talk_invoke,' which tells the agent exactly when the tool is relevant. It does not provide explicit 'when not to use' guidance or compare against every sibling, so it stops short of a 5.

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