list_knowledge_base_topics

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

With no annotations provided, the description carries the burden of behavioral disclosure. It is transparent about being a read-only listing operation by explaining it 'Returns an index of every topic' and referencing the companion get_knowledge_base() call. It does not explicitly state that it modifies nothing, but the list/return framing makes the non-destructive behavior clear.

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 compact and front-loaded with the primary purpose. Every section adds value: the return behavior, the usage guidance, the mandatory rule, the KB reference, and the example call. There is no filler or repeated schema 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 no-parameter listing tool, the description is complete. It explains what the tool returns, when to use it, why it matters, and where to find additional KB context. Since an output schema exists, the return format does not need to be restated in prose.

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 tool has zero parameters, so the schema already fully describes the call signature. The description reinforces this with an example call using no arguments, which is sufficient context for an agent to invoke the tool correctly.

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 ('List all available knowledge base topics') and the resource ('knowledge base topics'). It also clarifies that it returns an index of every topic queryable via get_knowledge_base(), which distinguishes it from the related sibling tool without needing to inspect schemas.

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 explicit guidance: call this first when unsure which topic covers the system you need. It also adds a MANDATORY rule to query the knowledge base before implementing any UE5 system, giving the agent a clear decision rule for when this tool is relevant.

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