Skip to main content
Glama

list_required_documents

Read-only

Fetch required compliance documents for a worker, contract, or country, with filters for submission status, pagination, and results limit.

Instructions

List required compliance documents for a worker, contract, or country.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoResults per page
offsetNoPagination offset
countryNoFilter by country code (ISO 2)
worker_idNoFilter by worker ID
contract_idNoFilter by contract ID
is_submittedNoFilter by submission status

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered by structured data. The description adds only the scope dimensions, not pagination behavior, default ordering, or what 'required' means (derived vs configured). It adds some value but no notable behavioral context.

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?

A single front-loaded sentence with no filler; the resource and the scoping options come first.

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 read-only filtered list tool with fully documented parameters and no output schema, the description covers what is needed to call it. It could note filter combination behavior, but nothing essential is missing.

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

Parameters3/5

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

Schema description coverage is 100%, so all six parameters (limit, offset, country, worker_id, contract_id, is_submitted) are documented in the schema itself. The description merely restates three of the filter axes without adding semantics such as precedence when multiple filters are supplied.

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?

States a specific verb ('List') and a specific resource ('required compliance documents') and enumerates the three scoping dimensions. It does not distinguish itself from near-siblings such as list_documents or list_document_templates, but an agent can tell what this tool returns.

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?

The scope phrase ('for a worker, contract, or country') implies when the tool is applicable, but there is no explicit when-to-use guidance and no mention of alternatives like list_documents. Usage is inferable rather than stated.

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