Skip to main content
Glama

grocy_files_get

Read-only

Download a Grocy file from a specified group by file name; returns text or base64 for small files and size details for large files.

Instructions

Download a file. GET /api/files/{group}/{fileName}. file_name is the plain name. The connector base64-encodes it. Small files return text or base64. Large files return size only. Server paths are omitted.

Input Schema

NameRequiredDescriptionDefault
groupYesFile group: equipmentmanuals, recipepictures, productpictures, userfiles, userpictures.
file_nameYesFile name including extension. The connector base64-encodes it for Grocy.
best_fit_widthNo
force_serve_asNo
best_fit_heightNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already mark this as read-only, non-destructive, and open-world, so the safety profile is covered. The description adds meaningful behavioral context beyond that: it explains base64 encoding, that small files return text or base64 while large files return size only, and that server paths are omitted.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short, front-loaded with the main action, and each sentence adds useful information. There is no wasted wording or redundant restatement.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the basic download action and important return-shape behavior for small versus large files. However, with five parameters and low schema description coverage, it leaves three optional parameters unexplained, which is a gap for an agent trying to use image-resizing or forced-content options correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 40%, so the description should compensate for undocumented parameters. It clarifies that file_name is the plain name and mentions base64 encoding, but does not explain group semantics beyond the enum, nor does it explain best_fit_width, best_fit_height, or force_serve_as.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Download a file') and adds the endpoint path, making it clear this is a file retrieval tool. It implicitly distinguishes from sibling tools like grocy_files_put and grocy_files_delete, but does not explicitly name or contrast them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no explicit guidance on when to use this tool versus alternatives such as grocy_files_put or grocy_files_delete. Usage is only implied by the word 'Download' and the endpoint path.

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