Skip to main content
Glama

offshoreproz_list_documents

Read-onlyIdempotent

List documents available for a formation.

Input Schema

NameRequiredDescriptionDefault
formation_idYesFormation ID whose documents to list (op_fm_* format).

Output Schema

NameRequiredDescriptionDefault
countYes
documentsYesList of documents associated with the formation

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

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, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds no behavioral context beyond that – no ordering, pagination, or emptiness behavior – but it does not contradict anything either.

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 short sentence with the resource and scope front-loaded and zero wasted words. Nothing could be trimmed without losing meaning.

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 one-parameter read-only list tool with complete schema annotations and an output schema, the description covers the essentials. Only minor gaps remain around how results are ordered or paginated, which the output schema likely addresses.

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 coverage is 100% and the single parameter already documents the op_fm_* ID format. The phrase 'for a formation' redundantly restates the parameter's role and adds no new syntax or constraint information, so baseline 3 applies.

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 resource ('documents') and scopes it to 'a formation', so the agent knows exactly what is returned. It is clearly distinct from siblings like get_formation_status or list_formations, though it does not name them explicitly.

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 only implied: the agent can infer it should call this when it needs the document set for a known formation. There is no explicit when-to-use condition, no mention of prerequisites (e.g. formation must exist), and no comparison against sibling tools.

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.