Skip to main content
Glama

kb_attachments_list

Read-onlyIdempotent

Paginated list of a document's attachments. Active (non-archived) only by default. Each row carries the attachment_uuid used to embed the file in a document body as kb-attachment://<uuid>.

Input Schema

NameRequiredDescriptionDefault
limitNoPage size (default 25, max 100)
offsetNoPagination offset (default 0)
document_idYesDocument id
tenant_slugNoTenant slug to target. Required when your token grants several workspaces; omit when it grants one. If you omit it with several, the refusal names your default workspace; call kb_tenants_list to see every workspace the token grants.
include_archivedNoInclude archived attachments (default false)

Output Schema

NameRequiredDescriptionDefault
totalYes
attachmentsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds real behavioral context beyond that: default filtering out archived attachments, pagination, and the per-row attachment_uuid with its `kb-attachment://<uuid>` embed syntax.

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?

Three short sentences, front-loaded with the core purpose, then the default filtering behavior, then the practically important uuid detail. Nothing is redundant.

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?

An output schema exists, so return values needn't be spelled out, and the description still gives the one return detail that matters operationally (the uuid embed format). For a read-only paginated list the entry is essentially complete; only explicit sibling routing is absent.

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%, so all five parameters including limit/offset and the tenant_slug fallback rule are already documented in the schema. The description only reinforces the include_archived default; it adds no parameter syntax or format details beyond the structured fields.

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 ('Paginated list of a document's attachments') with scope immediately clear. Among siblings (kb_attachments_get, archive, restore, list) an agent can pick this one without opening a schema.

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 'Active (non-archived) only by default' clause implies when this listing is and isn't sufficient, but the description never explicitly names alternatives such as kb_attachments_get for a single item or the archive/restore siblings. Usage is implied rather than stated.

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.