get_model_doc

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

The description discloses behavioral traits beyond annotations (readOnlyHint, openWorldHint): it explains that without a method name, a compact summary is returned, and with a method name, full documentation is returned. It also mentions the required group for access. No contradiction with 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 well-structured with paragraphs and front-loaded key information. It is detailed but not overly verbose. A slight reduction in explanatory prose could be made, but every sentence serves a purpose.

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 simplicity (2 params, no output schema, annotations present), the description is complete. It covers input semantics, output behavior (compact vs full), and access requirements. No critical gaps exist.

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?

Despite 0% schema description coverage, the description thoroughly explains both parameters. 'model' is described as the Odoo model name with an example. 'method' is described as optional, and its effect on the output (summary vs full docs) is clearly stated, adding significant 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's purpose: 'Get API documentation for an Odoo model.' It distinguishes between two modes (compact summary vs full documentation) based on the method parameter. It also differentiates from sibling tools like call_method by explicitly advising usage before 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 advises using this tool before call_method to discover parameter names and types, providing clear context. It mentions a prerequisite (API key user must be in the api_doc.group_allow_doc group). However, it does not explicitly state when not to use it or provide alternatives for other related tasks (e.g., using get_model_fields for field definitions).

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