hermes_get_document

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

With no annotations available, the description carries the full burden. It discloses the input format requirement, the 404 error behavior for wrong IDs, and the output contents, which is strong for a simple read operation.

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?

Every sentence earns its place: purpose, returned fields, critical input warning, and the prerequisite workflow. The most important information is front-loaded, and the description stays focused despite the warning complexity.

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 single-parameter read tool with no output schema and no annotations, this description is complete. It tells the agent what to pass, how to obtain it, what will be returned, and what happens if the wrong value is supplied.

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 already covers the parameter at 100%, so the baseline is 3. The description adds value by emphasizing the objectID versus docNumber distinction and the required upstream call to hermes_search, going beyond the schema.

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 the specific verb 'Get' and resource 'full metadata for a specific Hermes document by its SharePoint objectID,' and enumerates the returned fields. This clearly differentiates it from search and create/update siblings.

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?

Explicitly instructs to call hermes_search first to obtain the objectID, warns against using the human-readable docNumber, and states the 404 failure mode. This provides concrete when-to-use and when-not-to-use guidance.

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