Skip to main content
Glama

List Documents

list_docs

Retrieve a list of documents in a specified workspace using GraphQL API. Supports pagination via parameters: first, offset, and after for efficient document management.

Instructions

List documents in a workspace (GraphQL).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
afterNo
firstNo
offsetNo
workspaceIdNoWorkspace ID (optional if default set).
Behavior2/5

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

No annotations are provided, so the description carries full burden. It mentions 'List documents in a workspace' which implies a read-only operation, but doesn't disclose behavioral traits like pagination behavior (suggested by 'after', 'first', 'offset' parameters), authentication requirements, rate limits, or what the response contains. The '(GraphQL)' hint suggests a GraphQL API but doesn't explain implications. For a tool with 4 parameters and no annotation coverage, this leaves significant behavioral gaps.

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?

The description is appropriately brief (one sentence with a parenthetical). It's front-loaded with the core action and resource. The '(GraphQL)' addition is potentially useful for technical context. No wasted words, though it could be more informative without sacrificing conciseness.

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?

Given the complexity (4 parameters, no annotations, no output schema), the description is incomplete. It doesn't explain the tool's behavior, output format, error conditions, or how parameters interact. For a list operation with pagination controls, users need to know what 'list' returns and how to navigate results. The description fails to provide necessary context for effective use, especially with sibling tools like 'search_docs' that might overlap.

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 low (25% - only workspaceId has a description), so the description should compensate but doesn't. It mentions 'in a workspace' which aligns with the optional workspaceId parameter, but doesn't explain the pagination parameters (after, first, offset) or their relationships. No additional parameter meaning beyond the minimal schema is provided. With 0 required parameters and 3 undocumented ones, the description adds marginal value, meeting the baseline for moderate schema coverage.

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?

The description states the verb ('List') and resource ('documents'), but is vague about scope and mechanism. It mentions 'in a workspace' which provides some context, but doesn't specify what types of documents or what 'list' entails (e.g., paginated results, metadata only). The '(GraphQL)' parenthetical adds technical context but doesn't clarify functional purpose. It distinguishes from obvious non-list siblings but not clearly from other list/search tools like 'search_docs' or 'recent_docs'.

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 guidance on when to use this tool versus alternatives. The description doesn't mention when to choose 'list_docs' over 'search_docs', 'recent_docs', or 'get_doc', nor does it specify prerequisites like authentication or workspace context. The only implied context is workspace filtering, but even that is unclear since workspaceId is optional. No exclusions or alternative recommendations are provided.

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DAWNCR0W/affine-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server