get_resource_file

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

With no annotations, the description carries the behavioral transparency burden. It accurately conveys the download-and-save action and mentions the need for a local path. However, it does not disclose potential side effects (e.g., overwriting existing files, network access, or whether the operation is read-only with respect to the Joplin data). The description is not misleading but is sparse on behavioral details.

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 concise and well-structured: a brief purpose statement followed by a clear parameter list. Every sentence adds value, and the format is easy to scan. The mention of resource_id format is especially helpful without unnecessary fluff.

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 (two required parameters, no nested objects) and the presence of an output schema (though not shown), the description covers the essentials: what it does, how to get the resource_id, and what save_path should be. It also provides context for integration with file-reading tools. Minor gap: no mention of return behavior, but that may be covered by the output schema.

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 input schema only lists parameter names with no descriptions (0% schema coverage). The description compensates fully by explaining resource_id as the Joplin resource id from a note body link like ':/<id>' and save_path as an absolute local file path. This adds critical meaning and usage examples.

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: 'Download a Joplin resource's raw file... and save it to a local path.' It specifies the resource type and the action (download/save), and distinguishes it from sibling tools like get_resource_info (metadata) and get_resource_ocr_text (text extraction).

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 gives a clear usage context: after downloading, the file can be viewed with a file-reading tool. It also suggests calling get_resource_info first when the mime type is needed to choose an extension. It does not explicitly list exclusions or alternatives beyond that prerequisite, but the guidance is practical and sufficient.

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