Skip to main content
Glama

List documents

outline_list_documents
Read-onlyIdempotent

List documents in an Outline workspace, optionally filtered by collection or parent document, with pagination controls for browsing and retrieving specific results.

Instructions

List documents, optionally within a collection or under a parent. Args: collectionId, parentDocumentId, limit, offset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax results to return (1-100)
offsetNoResults to skip, for pagination
collectionIdNo
parentDocumentIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior3/5

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

Annotations declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true, so the safety and idempotency profile is covered. The description adds only the optional scoping context. It does not disclose pagination defaults (limit 25, offset 0) or return shape, which would be useful for an open-world read tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence with an arg list; front-loaded with the purpose and scoping. Efficient, though the trailing 'Args:' enumeration is low-value since parameters are already in the schema.

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

Completeness2/5

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

For a list tool with no output schema, the description should clarify return format, pagination behavior, and how collectionId vs parentDocumentId are used. It omits all of these, leaving the agent to guess interactions and paging.

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 50%: limit and offset are well described in the schema; collectionId and parentDocumentId have no schema descriptions. The description merely names the four args without explaining semantics (e.g., that the two scoping params are mutually exclusive or how they interact). It does not compensate for the coverage gap.

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

Purpose3/5

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

States a clear verb+resource ('List documents') with scoping qualifiers. However, it does not distinguish itself from siblings outline_list_collection_documents and outline_search, which also list/return documents. The purpose is adequate but lacks sibling differentiation.

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

Usage Guidelines2/5

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

No explicit when-to-use or when-not-to-use guidance. The description implies scoping via optional params but does not route the agent to outline_list_collection_documents for collection-scoped listing or outline_search for queries. No alternatives are named.

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