Skip to main content
Glama
Odoo Connect MCP

Odoo Connect MCP

by Tristan439

Describe a model

describe_model
Read-onlyIdempotent

Lists a model’s fields with labels, types, and related models so you can inspect its structure before searching data you have not used yet.

Instructions

Lists the fields of a model with their label, type and related model. Call this before searching a model you have not used yet.

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": "describe_model"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelYesTechnical model name, e.g. "sale.order", "res.partner", "crm.lead"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile needs no restating. The description adds useful behavior beyond that by disclosing the shape of what comes back (label, type, related model) and its role as a pre-search introspection step. It does not say how many fields are returned or how large/deep models are handled, which is the remaining gap.

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?

Two sentences, both earning their place: the first defines the output, the second defines the workflow trigger. It is front-loaded with the purpose and contains no filler or repetition of the name.

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

Completeness4/5

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

For a single-parameter read-only introspection tool with no output schema, the description covers the essentials: what it returns and when to reach for it. The one shortfall is error behavior for unknown model names, which an agent calling with a guessed technical name would benefit from knowing.

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?

With one parameter at 100% schema description coverage, the schema already documents the model argument and supplies concrete examples ("sale.order", "res.partner", "crm.lead"). The description adds no further meaning about the identifier format or what happens with an invalid or unknown model name, so the baseline 3 applies.

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 uses a specific verb and resource ("Lists the fields of a model") and enumerates what each field entry contains: label, type and related model. That is far more informative than the title's restatement, though it never contrasts itself with sibling metadata tools like list_models, so the agent must infer the distinction.

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?

It gives an explicit trigger: "Call this before searching a model you have not used yet." That tells the agent both the sequencing (introspect first) and the condition (unfamiliar model). What is missing is the inverse case – guidance on when to skip it, e.g. when the model's fields are already known.

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