Skip to main content
Glama
DAWNCR0W

AFFiNE MCP Server

by DAWNCR0W
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

List Documents

list_docs
Read-onlyIdempotent

Retrieve all documents in an AFFiNE workspace, including deleted items flagged in trash. Pagination supported with cursor or offset.

Instructions

List documents in a workspace (GraphQL). Each doc includes an inTrash flag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
afterNoCursor from pageInfo.endCursor for fetching the next page.
firstNoMaximum number of items to return from the AFFiNE pagination connection.
offsetNoZero-based offset used by AFFiNE pagination. Do not combine with after unless the AFFiNE API requires it.
workspaceIdNoAFFiNE workspace id. Omit only when AFFINE_WORKSPACE_ID is configured.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.5.0
    • addedInput schema / properties / after / description
      Added value: +"Cursor from pageInfo.endCursor for fetching the next page."
    • addedInput schema / properties / first / description
      Added value: +"Maximum number of items to return from the AFFiNE pagination connection."
    • addedInput schema / properties / first / exclusiveMinimum
      Added value: +0
    • changedInput schema / properties / first / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / offset / description
      Added value: +"Zero-based offset used by AFFiNE pagination. Do not combine with after unless the AFFiNE API requires it."
    • addedInput schema / properties / offset / minimum
      Added value: +0
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Workspace ID (optional if default set)."New value: +"AFFiNE workspace id. Omit only when AFFINE_WORKSPACE_ID is configured."
    • addedInput schema / properties / workspaceId / minLength
      Added value: +1
  2. Addedv1.12.0
  3. Removedv1.0.0
  4. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations (readOnlyHint, idempotentHint, destructiveHint) already cover the read-only and non-destructive nature. The description adds the detail about the 'inTrash flag' but provides no further behavioral context beyond annotations.

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?

Single sentence that is clear, front-loaded, and contains no extraneous information. Every word adds value.

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

Completeness3/5

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

Given the complexity of pagination (after, first, offset, workspaceId) and no output schema, the description omits details about how pagination works or the return structure. It is adequate but not comprehensive.

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?

Input schema coverage is 100% with all four parameters described. The description does not augment the schema's parameter descriptions, so baseline 3 is appropriate.

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?

The description clearly states the verb 'List' and the resource 'documents in a workspace', adding a specific detail about the output ('Each doc includes an inTrash flag'). It distinguishes from sibling tools like search_docs or get_doc.

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?

No explicit guidance on when to use this tool versus alternatives such as list_docs_by_tag or search_docs. The mention of GraphQL is present but does not clarify context for usage.

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

Deploy Server

Other Tools