edit_forum_topic

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

With no annotations provided, the description bears full responsibility for behavioral disclosure. It mentions actions (change title, toggle/hide) but fails to specify permissions required, side effects (e.g., whether closing a topic hides it from all users), or the reversible nature of these actions.

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. It conveys core functionality efficiently, but could benefit from slight expansion to cover parameters without losing brevity.

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 five parameters and an existing output schema, the description leaves gaps: no mention of output, no relation to sibling tools like get_forum_topics, and no explanation of default parameter behavior. Insufficient for an AI to infer correct usage independently.

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 description covers only two of five parameters (title, closed/hidden), leaving chat and topic_id unexplained. The schema has 0% description coverage, so the description should compensate but does not clarify required fields or the meaning of null defaults for closed and hidden.

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 modifies a forum topic's title or toggles its closed/hidden state. It distinguishes from sibling tools like create_forum_topic (creation) and get_forum_topics (listing) by focusing on modification.

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 the tool is for editing existing topics, but does not explicitly state when to use it versus alternatives or provide context like prerequisites (e.g., user must be an admin or topic owner). No guidance on when not to use it.

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