Skip to main content
Glama
solutionsunity

OdooSurface MCP

search_records

Find Odoo records by name or model-specific identifiers, with optional domain or action_id filters. Use list_records to filter by field values.

Instructions

Find records by name — "which record is called X" — with the model's own name matching (display name, plus per-model keys such as reference, email or code). domain / action_id narrow the search. For filtering by field values use list_records. Pass context for search-time behaviour — e.g. {active_test: false} finds archived records, {lang: "fr_FR"} matches and returns display_name in that language. Returns [{id, display_name}] up to limit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
modelYes
queryYes
domainNo
contextNo
action_idNo
output_pathNoAbsolute path on the MCP server host. When given, the full JSON result is written there and the tool returns only {output_path, total, count} — for results too large for context or meant for scripts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.6.1
    • addedInput schema / properties / output_path
      Added value: +{
      +  "description": "Absolute path on the MCP server host. When given, the full JSON result is written there and the tool returns only {output_path, total, count} — for results too large for context or meant for scripts.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "model"
      -]New value: +[
      +  "model",
      +  "query"
      +]
  2. First observedv0.5.1

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations the description carries the full burden, and it does disclose real behaviour: what is matched (display name plus per-model keys like reference, email, code), how context alters results (active_test:false surfaces archived; lang changes matching and display_name language), and the return shape. It omits auth/permission requirements and any rate or error behaviour, so it is strong but not complete.

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

Conciseness4/5

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

Front-loaded with the core intent, then progressively adds scoping, alternative routing, context examples, and return shape. Dense but every sentence adds information; it is slightly long, with parenthetical asides, but nothing is wasted.

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 7-parameter, nested-object tool with no output schema, the description supplies the return format ([{id, display_name}] up to limit), matching semantics, and context effects — covering most of what an agent needs. It leaves permission/auth behaviour and the precise semantics of domain/action_id unstated.

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

Parameters4/5

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

Schema description coverage is only 14%, so the description must compensate and largely does: it defines semantics for query (name matching), model (per-model name keys), domain/action_id (narrowing), and context (with two worked examples). The limit and output_path parameters carry no explanation in the description, but output_path is documented in the schema and limit's 'up to limit' hints at pagination.

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 ('Find records by name') and pins the exact intent with the quoted phrasing 'which record is called X'. It also explicitly distinguishes itself from the sibling list_records, so an agent can route correctly without opening a schema.

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

Usage Guidelines5/5

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

Names the alternative and the condition that selects it ('For filtering by field values use list_records'), and explains what domain/action_id are for (narrowing) and what context is for (search-time behaviour, with concrete examples). Conditions for the main branch points are all stated.

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