Skip to main content
Glama
erpipe-org

Odoo MCP Server

by erpipe-org

get_model_fields

Read-onlyIdempotent

Retrieve field metadata for any Odoo model, including field types and properties. Specify a model and optional field names to discover available fields for building Odoo queries.

Instructions

Get field metadata for a specific Odoo model

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelYes
instanceNo
relevanceNo
max_fieldsNo
field_namesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolNoReporting tool name.
countNo
errorNoSanitized error message when success is false.
resultNoMapping of field name to fields_get metadata.
rankingNoRelevance scores when relevance="top".
successYesFalse when the call failed; see error.
relevance_appliedNo
restricted_fieldsNoFields marked restricted by the field ACL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv1.1.0
    • addedOutput schema / additionalProperties
      Added value: +true
    • addedOutput schema / properties / count
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Count"
      +}
    • addedOutput schema / properties / error
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Sanitized error message when success is false.",
      +  "title": "Error"
      +}
    • addedOutput schema / properties / ranking
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Relevance scores when relevance=\"top\".",
      +  "title": "Ranking"
      +}
    • addedOutput schema / properties / relevance_applied
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Relevance Applied"
      +}
    • addedOutput schema / properties / restricted_fields
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Fields marked restricted by the field ACL.",
      +  "title": "Restricted Fields"
      +}
    • removedOutput schema / properties / result / additionalProperties
      Removed value: -true
    • addedOutput schema / properties / result / anyOf
      Added value: +[
      +  {
      +    "additionalProperties": true,
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedOutput schema / properties / result / default
      Added value: +null
    • addedOutput schema / properties / result / description
      Added value: +"Mapping of field name to fields_get metadata."
    • removedOutput schema / properties / result / type
      Removed value: -"object"
    • addedOutput schema / properties / success
      Added value: +{
      +  "description": "False when the call failed; see error.",
      +  "title": "Success",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / tool
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Reporting tool name.",
      +  "title": "Tool"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "success"
      +]
    • changedOutput schema / title
      Previous value: -"get_model_fieldsOutput"New value: +"GetModelFieldsResponse"
  2. Changed3 schema fields changedv1.0.0
    • addedInput schema / properties / instance
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Instance"
      +}
    • addedInput schema / properties / max_fields
      Added value: +{
      +  "default": 30,
      +  "title": "Max Fields",
      +  "type": "integer"
      +}
    • addedInput schema / properties / relevance
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Relevance"
      +}
  3. First observedv0.2.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already indicate read-only, idempotent, and non-destructive behavior. The description adds no additional behavioral context (e.g., pagination, filtering behavior, or performance implications).

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

Conciseness3/5

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

The description is a single sentence, which is concise but lacks necessary detail. It is appropriately front-loaded but underinformative.

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

Completeness2/5

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

Given five parameters and no schema descriptions, the description is incomplete. It fails to explain parameters, output schema, or usage nuances, leaving agents without essential context.

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

Parameters1/5

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

Schema description coverage is 0%. The description does not explain any of the five parameters (model, instance, relevance, max_fields, field_names), providing no added meaning beyond the schema's field names.

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?

The description uses a specific verb ('Get') and resource ('field metadata for a specific Odoo model'), clearly distinguishing it from sibling tools like list_models or search_records.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives such as inspect_model_relationships or schema_catalog. No context about prerequisites or when not to use it.

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