Skip to main content
Glama

Field Service Business Platform by Doing Work

documents_photoReport

Render a photo report PDF for a job: a title and the worker's own notes, then the job's photos in time order with stage and tags. Name photos with media_ids or leave it out for every photo on the job. Core stores the PDF with its sha256 and returns it (base64).

Input Schema

NameRequiredDescriptionDefault
notesNo
titleNo
job_idYes
media_idsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description still discloses important behavior: the PDF is stored by Core with its sha256 and returned as base64, and photos are ordered by time with stage and tags. It does not cover authentication, idempotency, or what happens on repeated calls, but it adds substantial behavioral context beyond structured fields.

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 three tight sentences with no filler. Purpose and report contents come first, followed by media selection behavior and output/storage details, so it is well front-loaded.

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

Completeness4/5

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

For a four-parameter PDF-generation tool with no annotations or output schema, the description covers purpose, key input behavior, storage side effect, and return format. It leaves out explicit sibling-tool routing and access/error behavior, but an agent has enough to invoke it correctly.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must carry parameter meaning. It explains title, worker notes, and crucially the media_ids behavior: specify IDs to select photos, or omit it to include every photo on the job. Only job_id lacks explicit explanation, though its role is clear from context.

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

Purpose5/5

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

The description opens with a specific verb and resource: "Render a photo report PDF for a job." It then enumerates the report contents, distinguishing this from sibling document tools such as documents_dailyLog or documents_get by resource and output type.

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

Usage Guidelines3/5

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

Usage is implied by the purpose, but the description never explicitly says when to choose this tool over documents_dailyLog or documents_get. It gives useful guidance on omitting media_ids for all photos, but that is parameter selection rather than tool-selection guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources