Skip to main content
Glama
odoo-mcp-server

odoo-mcp-server

Describe a model

odoo_describe_model
Read-onlyIdempotent

Returns a model's field types, labels, relations, selections, help text and required/readonly flags. Use it before filtering, sorting or choosing fields on an unfamiliar model; it returns no records.

Instructions

Describe the fields of one model: for each field its type, label, related model (and whether that model is available too), selection values, help text, and required, readonly or not-stored flags. Also returns the model's hint, default_fields and max_records_per_call. Use it before filtering, sorting, grouping or choosing fields on a model you have not used yet; it returns no records (use odoo_search for data). Passwords, tokens, keys, files and fields hidden by the administrator are never listed and cannot be used.

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
modelYesTechnical model name from odoo_list_models, e.g. 'res.partner' or 'sale.order'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.1
    • changedInput schema / properties / model / description
      Previous value: -"Technical model name, e.g. 'res.partner'."New value: +"Technical model name from odoo_list_models, e.g. 'res.partner' or 'sale.order'."
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed world), and the description adds genuinely new behavior: it returns no records, it exposes model-level metadata (hint, default_fields, max_records_per_call), and credential-like fields (passwords, tokens, keys, files, admin-hidden fields) are never listed and cannot be used. That last point is a security/access constraint an agent could not infer from structured fields.

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?

Front-loaded with the outcome, then the trigger, then the exclusion about records, then the security boundary — a logical order with no filler. Dense enumerations are justified because no output schema exists to carry the return-value detail.

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

Completeness5/5

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

For a single-parameter introspection tool with no output schema, the description covers what is returned, that no records come back, which sibling handles data, and what is deliberately withheld. An agent has everything needed to call it correctly and interpret the result.

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

Parameters3/5

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

Only one parameter and schema description coverage is 100%, so the schema already documents 'model' with the same example format and the same 'from odoo_list_models' provenance the description gives. The description adds no new syntax, naming convention, or error-case detail beyond the schema, so the baseline 3 applies.

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

Purpose5/5

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

States a specific verb and resource ('Describe the fields of one model') and enumerates exactly what comes back: per-field type, label, related model availability, selection values, help text, and required/readonly/not-stored flags. It also distinguishes itself from odoo_search by declaring it returns no records, so an agent can tell it apart from siblings without opening any schema.

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?

Gives an explicit trigger ('use it before filtering, sorting, grouping or choosing fields on a model you have not used yet') and routes data retrieval to odoo_search. What's missing is guidance for the inverse case — whether it is pointless/harmful to call on a model already explored, or any cost/latency caveat for repeated calls.

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