io.github.singleflo/odoo-assistant

Overview Schema Source Related Servers Discussions Admin

explore_module

Explore a live Odoo module's structure to understand its models and relationships. Generate a reference document or get a ranked list of models worth investigating.

Instructions

Discover a module's structure by interrogating the live instance.

Args: module_name: Module to explore, e.g. "helpdesk". Must be a module slug, since it names the reference file on "generate"; ignored on "list". action: "generate" (the default) writes the reference document, "list" ranks what is worth exploring. models: Comma-separated models for a module the script does not know, e.g. "superchat.message,superchat.template". Defaults to the script's own grouping for module_name.

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": {
      "module_name": "<module_name>"
    },
    "name": "explore_module"
  }
}

Input Schema

Name	Required	Default
`action`	No	generate
`models`	No
`module_name`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.1Aug 18, 2026

TDQS

B3.1/5.0

Behavior2/5

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

With no annotations, the description must fully disclose behavioral traits. It mentions actions (writes reference document vs. ranks) but does not clarify side effects (e.g., does 'generate' modify the system?), read vs. write nature, or required permissions. This leaves significant ambiguity for a tool that appears to produce artifacts.

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?

The description is front-loaded with a clear purpose sentence, followed by a structured parameter block. Each parameter gets a concise explanation. No redundant information. Could be slightly more compact but remains efficient.

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?

An output schema exists but the description neither references nor explains return values (especially for 'list' action). It covers parameter behavior adequately but omits error conditions, prerequisites (e.g., is the module installed?), and the structure of the generated document. Some gaps remain despite reasonable param coverage.

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 coverage is 0%, so description must compensate. It explains module_name is a slug and ignored on 'list', actions define output behavior, and models provides comma-separated overrides. This adds essential meaning beyond the schema's bare defaults and types.

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 clearly states the tool discovers a module's structure by interrogating the live instance, with specific actions (generate/list). This distinguishes it from sibling tools like list_known_modules which likely only lists module names, though it could be more precise about 'structure' meaning.

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 explicit guidance on when to use this tool versus alternatives, such as comparing with search_read or list_known_modules. The description does not advise on choosing between 'generate' and 'list' actions beyond defining them, and omits any when-not-to-use scenarios.

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