Skip to main content
Glama

list-documents

Read-only

List the documents stored for a company in Osome that the user can see, in the order they were added (oldest first), one page at a time. Returns documents, each with only its Core document id and name, and no total count: request the next page until one returns fewer than perPage documents. Use get-document to look up one document by ID, list-invoices for sales invoice details, or prepare-document-upload to add a file.

Input Schema

NameRequiredDescriptionDefault
idYesCompany ID, as returned by list-companies
pageNoPage number, starting at 1 (default 1).
perPageNoDocuments per page (default 20, max 100).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / id / description
      Previous value: -"Company ID"New value: +"Company ID, as returned by list-companies"
    • changedInput schema / properties / page / description
      Previous value: -"Page number (default 1)"New value: +"Page number, starting at 1 (default 1)."
    • changedInput schema / properties / perPage / description
      Previous value: -"Items per page (default 20, max 100)"New value: +"Documents per page (default 20, max 100)."
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: ordering (oldest first), the absence of a total count, and the exact pagination termination rule (stop when a page returns fewer than perPage items). It stops short of noting permissions/rate limits, but the pagination disclosure is substantive.

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?

Two sentences, front-loaded with what the tool returns and how it pages, then the sibling routing. Every clause carries information; nothing is filler.

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

Completeness5/5

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

With no output schema, the description carries the burden of explaining returns and does so (only Core document id and name, no total count) plus the pagination loop needed to enumerate fully. Nothing an agent needs to call this correctly is missing.

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 coverage is 100%, so page/perPage defaults and the company id are already documented, setting the baseline at 3. The description adds value by tying perPage to the pagination stop condition, giving the parameter behavioral meaning beyond its schema definition.

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?

States a specific verb and resource ('List the documents stored for a company') with scope qualifiers ('that the user can see', ordered oldest first, paged). It is immediately distinguishable from get-document, list-invoices, and prepare-document-upload, which it names explicitly.

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

Usage Guidelines5/5

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

Explicitly routes the agent: use get-document for a single lookup by ID, list-invoices for sales invoice details, prepare-document-upload to add a file. The when-to-use-this-tool case is implied by the scoping statement, and the alternatives are all named with their conditions.

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