Skip to main content
Glama
odoo-safe-mcp
by makelele29

odoo_describe_model

Read-onlyIdempotent

Inspect an Odoo model's fields—labels, types, relations, required, and readonly flags—before writing data. Use it to verify schema and avoid invalid field writes.

Instructions

Describe a model's fields (label, type, relation, required, readonly). Use before writing.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "model": "<model>"
    },
    "name": "odoo_describe_model"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.0.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare the tool as read-only, idempotent, closed-world, and non-destructive. The description adds the returned field categories and a workflow hint, but it does not disclose failure modes, permission needs, or other behavioral context beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two short sentences with no wasted words. The core purpose is front-loaded, and the usage hint follows immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is simple and read-only, and an output schema exists, so return values need not be explained in detail. However, the description leaves the required "model" parameter format ambiguous, which is a meaningful gap for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is one required parameter, "model," with 0% schema description coverage. The description does not explain the expected format, such as a technical model name or an example value, so it does not compensate for the schema gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: describe a model's fields. It also lists the field metadata returned. It does not explicitly differentiate itself from siblings such as odoo_list_models, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase "Use before writing" gives a clear usage trigger. However, it does not name alternatives, exclusions, or the conditions under which this tool should not be used.

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