Get MO41 Document PDF File Info

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's addition of 'without downloading' provides some context but is not critical. The description does not disclose other behavioral aspects like return format or pagination, which, given no output schema, would be valuable. Still, annotations carry most of the transparency burden here.

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 extremely concise: three lines with no unnecessary words. It front-loads the purpose and then lists the parameter. Every sentence is essential and earned its place.

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?

Given the tool's simplicity (one param, no output schema), the description is mostly adequate. However, it omits what specific metadata fields are returned (e.g., file name, size, type). For a file info tool, this could help the agent decide if it's sufficient. Still, the core purpose is clear and complete for basic use.

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% with description 'Consignment ID' for the only parameter. The description repeats this exactly without adding new meaning (e.g., format, source, or constraints). With high schema coverage, baseline is 3, and this description meets it without enhancement.

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 verb 'Returns' and the resource 'file metadata for the MO41 document PDF', distinguishing it from sibling tools like machship_get_mo41_document_pdf which presumably downloads the file. The title also aligns well.

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?

The description hints at usage by saying 'without downloading it', implying that if the agent needs the actual file, it should use another tool. However, it does not explicitly name the alternative tool or provide when-not-to-use conditions. Given the large set of siblings, a more explicit reference would be better.

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