Look up a Maximo error code
lookup_error_codeFind published records about a specific Maximo error or fix identifier (BMXAA1234E, IJ12345, APAR...).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | The error/fix code, e.g. "BMXAA4214E". |
lookup_error_codeFind published records about a specific Maximo error or fix identifier (BMXAA1234E, IJ12345, APAR...).
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | The error/fix code, e.g. "BMXAA4214E". |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It implies a read operation ('Find') but does not mention permissions, rate limits, return format, or what 'published records' entails. This is a significant gap for a tool with zero annotation coverage.
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, well-structured sentence that front-loads the purpose and includes useful examples. There is no redundancy or filler.
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?
For a simple lookup with one parameter and no output schema, the description is mostly sufficient. However, it does not specify the return structure (e.g., whether multiple records may be returned, or if a not-found case is handled), leaving some ambiguity for the agent.
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?
The schema documents the 'code' parameter with an example, and the description adds multiple example formats (BMXAA1234E, IJ12345, APAR...), enhancing the agent's understanding of acceptable inputs beyond the schema's single example.
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 clearly states the tool's function: finding published records for a specific Maximo error or fix identifier, with concrete examples of code formats. It distinguishes itself from generic record tools by targeting error codes specifically, though it does not explicitly name siblings it is not.
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?
No guidance is given on when to use this tool versus alternatives like search_records or get_record. The description implies usage when you have an error code, but does not state exclusions or recommend when a different tool would be more appropriate.
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.