create_doc

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

Annotations already cover safety hints, and the description adds substantial behavioral detail: it returns metadata and a version usable as update_doc's base_version, the body is not echoed back, slug violations return 400, and parent_id nesting affects the resulting path. This is rich context beyond structured annotations.

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 dense and front-loaded with the core action, then layers in return behavior, slug constraints, and nesting rules. Every sentence carries actionable information with no padding.

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?

With no output schema, the description appropriately explains return values (metadata and version) and non-returned content (the body). Combined with annotations covering safety, it gives an agent enough to create documents correctly, including the tricky slug and parent_id rules.

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%, so the baseline is 3. The description elaborates on slug and parent_id semantics—specifically the 400 refusal, folder nesting, and the resulting '<parent-slug>/<slug>' reachability—which adds value beyond the schema, though most other parameters are left to 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?

States a specific verb and resource: 'Create a document in a project.' It also references the sibling update_doc via the base_version workflow, so the agent can distinguish creation from later edits without opening 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?

Explains a key create-then-edit workflow ('a create followed by an edit needs no read in between') and gives nesting guidance. It lacks an explicit when-not clause or direct routing to update_doc for modifying existing documents, but the usage context is clear.

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