Skip to main content
Glama
erpipe-org

Odoo MCP Server

by erpipe-org

search_records

Read-onlyIdempotent

Search Odoo records through a read-only search_read operation; use an optional free-text query to match name, reference, and email-like fields.

Instructions

Search Odoo records with read-only search_read; optional free-text query matches across name/ref/email-like fields

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
modelYes
orderNo
queryNo
domainNo
fieldsNo
offsetNo
instanceNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolNoReporting tool name.
countNo
errorNoSanitized error message when success is false.
resultNoMatched records (field-ACL redacted).
successYesFalse when the call failed; see error.
fields_usedNo
redacted_fieldsNo
query_fields_usedNoFields matched by the free-text query shortcut.
smart_fields_appliedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 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 / fields_used
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Fields Used"
      +}
    • addedOutput schema / properties / query_fields_used
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Fields matched by the free-text query shortcut.",
      +  "title": "Query Fields Used"
      +}
    • addedOutput schema / properties / redacted_fields
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Redacted Fields"
      +}
    • removedOutput schema / properties / result / additionalProperties
      Removed value: -true
    • addedOutput schema / properties / result / anyOf
      Added value: +[
      +  {
      +    "items": {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedOutput schema / properties / result / default
      Added value: +null
    • addedOutput schema / properties / result / description
      Added value: +"Matched records (field-ACL redacted)."
    • removedOutput schema / properties / result / type
      Removed value: -"object"
    • addedOutput schema / properties / smart_fields_applied
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Smart Fields Applied"
      +}
    • 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: -"search_recordsOutput"New value: +"SearchRecordsResponse"
  2. Changed2 schema fields changedv1.0.0
    • addedInput schema / properties / instance
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Instance"
      +}
    • addedInput schema / properties / query
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Query"
      +}
  3. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior. Description adds that it uses the search_read method and that query matches name/ref/email-like fields, providing context beyond 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?

Single, front-loaded sentence efficiently conveys purpose and key feature (free-text query). No extraneous text; every word contributes.

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?

With 8 parameters and existing output schema, description covers core search intent but omits details on filtering with domain, field selection, ordering, and pagination. Adequate but incomplete for complex use.

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?

Schema coverage is 0% so description must compensate. Only 'query' parameter receives partial description (matches across fields). Other seven parameters (limit, order, domain, etc.) are not described, leaving significant gaps.

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 clearly states 'Search Odoo records with read-only search_read', specifying verb and resource. It distinguishes from sibling tools like search_across_instances by focusing on single-instance search.

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

Usage Guidelines3/5

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

Description mentions optional free-text query but does not specify when to use this tool versus alternatives such as search_across_instances or model-specific searches. No explicit when-not or usage context.

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