analyze_machine_docs
AI analysis of machine documentation. Upload docs to get suggested capabilities, extracted specs, materials, and tolerances.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document | No | Document content or reference to analyze |
AI analysis of machine documentation. Upload docs to get suggested capabilities, extracted specs, materials, and tolerances.
| Name | Required | Description | Default |
|---|---|---|---|
| document | No | Document content or reference to analyze |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false and destructiveHint=false, so safety is partly covered and the description's 'upload docs' wording is consistent with a non-read-only but non-destructive operation. The description adds the returned artifacts, but says nothing about whether an analysis record is persisted, what the document reference format is, or any cost/latency.
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?
Two short sentences, front-loaded with what the tool is before what it returns. No filler, though the output list is compressed into one comma run.
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?
With no output schema, listing the returned artifacts is genuinely useful and partially compensates. However, for a single-parameter tool whose schema marks 'document' as optional (required: []), the description implies upload is necessary without reconciling that, and leaves persistence/return format unspecified.
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?
Schema coverage is 100% for the single 'document' parameter, so the schema already explains it as 'content or reference'. 'Upload docs' in the description reinforces the intent but adds no syntax, format, or size guidance beyond the schema. Baseline 3 applies.
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?
States a specific resource ('machine documentation') and an analysis action, and enumerates the outputs (suggested capabilities, specs, materials, tolerances), which makes the function concrete. It does not, however, distinguish itself from adjacent siblings like onboard_machine or create_capability, which could plausibly consume similar inputs.
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?
There is no when-to-use or when-not-to-use guidance, and no alternatives are named despite a large sibling set. 'Upload docs to get...' implies the input shape but not the conditions under which this tool is the right choice.
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.