Edit a topic

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states that the topic is changed 'in place', that the comment header is preserved, that nodes can be removed by id, and that the file is validated afterwards. This gives the agent a sense of mutation and post-conditions, though it does not mention reversibility, permissions, or failure modes.

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, dense sentence that front-loads the core action ('Change an existing topic in place') and then lists operations. It avoids fluff and includes a relevant behavioral note (validation). It is efficient, though the long list of operations makes it slightly less scannable than a bulleted breakdown.

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?

Given the tool's complexity (11 parameters, nested action objects, no output schema), the description is incomplete. It does not explain the return value, error conditions, or the workspace parameter's behavior. It references cs_add_topic for node specs but does not detail them. The validation note is helpful but insufficient for an agent to fully understand consequences and prerequisites.

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 only 36%, so the description must compensate. It explains the purpose of several parameters (rename, description, trigger phrases set/add/remove, priority, append/insert nodes, remove top-level nodes) but does not describe workspace semantics, the exact structure of trigger phrase arrays, or the null behavior for priority. It references cs_add_topic for node spec, which helps but is indirect. Overall, it adds moderate meaning beyond 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 clearly states the tool changes an existing topic in place, and enumerates the supported edit operations (rename, description, trigger phrases, priority, node append/insert, node removal). This differentiates it from cs_add_topic which creates new topics, but it does not explicitly name sibling tools or the precise conditions for choosing it.

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 for editing existing topics (as opposed to adding new ones via cs_add_topic) and references the same node spec as cs_add_topic, but it does not explicitly state when to use this tool over alternatives, nor does it provide exclusions or prerequisites like workspace setup. Guidance is inferred rather than explicit.

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