Get Module
get_moduleRead a field module's definitions and available options.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| moduleId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
get_moduleRead a field module's definitions and available options.
| Name | Required | Description | Default |
|---|---|---|---|
| moduleId | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world behavior, so the safety profile is covered. The description adds that the tool returns definitions and available options, but does not disclose error behavior, missing-module handling, or permission requirements; with rich annotations, this is adequate but not strong.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no filler or repetition. Every word contributes to identifying the tool's scope.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and annotations cover safety. However, the lone input parameter is unexplained, there is no guidance on retrieving a valid moduleId, and usage versus list_modules is left implicit, leaving gaps for a simple read tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is one required parameter, moduleId, but the schema description coverage is 0%, so the description must compensate and does not. It never mentions moduleId, its format, or where to obtain it, leaving the only parameter undocumented in both structured and natural-language fields.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb (read) and resource (a field module's definitions and available options), which distinguishes it from the sibling list_modules at a high level. It does not explicitly name list_modules as the broader alternative, but the singular scope is inferred from the wording.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: an agent can infer this is the tool to call when it needs a single module's definitions and options. There is no explicit when-to-use guidance, no mention of when to prefer list_modules, and no prerequisites or source for moduleId.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.