serve_wiki

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

Description reveals the server runs as a subprocess and can be stopped with stop_wiki_server, adding beyond annotations. Annotations indicate non-read-only, non-destructive, non-idempotent, and open-world; description aligns and adds behavioral context like subprocess launch.

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?

Two paragraphs with front-loaded action, clear structure: main purpose, details, prerequisite, example. No filler; every sentence adds value.

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?

Covers functionality, prerequisite, example, and shutdown guidance. With no output schema, it could mention startup confirmation or error handling, but overall provides sufficient context for typical use.

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 coverage is 100%, and the description repeats parameter info without adding new semantics. The example provides a concrete use case but does not clarify edge cases or format beyond 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 it starts an interactive wiki web server for a .deepwiki directory, launching a Flask app with specific UIs. It explicitly mentions the sibling tool stop_wiki_server for stopping, making purpose and differentiation clear.

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 provides a prerequisite (index_repository must be called first) and an example, guiding when to use. It doesn't explicitly state when not to use, but the dependency and stop tool provide clear context.

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