Skip to main content
Glama

appwrite_list_documents

Retrieve documents from an Appwrite collection using JSON queries to filter, sort, and paginate results for efficient data management.

Instructions

[UNIFIED] List documents in a collection with powerful query support.

Queries must be JSON objects (Appwrite 1.7.4 format):

  • {"method": "equal", "attribute": "status", "values": ["active"]}

  • {"method": "notEqual", "attribute": "type", "values": ["draft"]}

  • {"method": "greaterThan", "attribute": "price", "values": [100]}

  • {"method": "search", "attribute": "title", "values": ["keyword"]}

  • {"method": "orderAsc", "values": ["createdAt"]}

  • {"method": "orderDesc", "values": ["createdAt"]}

  • {"method": "limit", "values": [25]}

  • {"method": "offset", "values": [50]}

  • {"method": "cursorAfter", "values": ["documentId"]}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYes
database_idYes
collection_idYes
queriesNo
Behavior3/5

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

With no annotations provided, the description carries the full burden. It excellently discloses the Appwrite 1.7.4 query DSL format with concrete examples (equal, notEqual, cursorAfter, etc.), which is critical behavioral context not present elsewhere. However, it omits other necessary behavioral details: whether results are paginated, total limit constraints, error behavior for invalid collection IDs, or authentication requirements.

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 front-loaded with the purpose statement followed by detailed query examples. While the example list is lengthy (9 bullet points), each is necessary given the complexity of the Appwrite query DSL and the lack of schema descriptions. Structure is logical and scannable, though the '[UNIFIED]' prefix serves no clear semantic purpose.

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 complex query capabilities (nested JSON methods) and zero schema coverage, the description adequately covers the query syntax complexity. However, it fails to explain the hierarchical resource addressing (site → database → collection), omits return value documentation, and lacks pagination behavior details that would be expected for a 'list' operation with cursor/limit methods.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description must compensate for all four parameters. While it extensively documents the 'queries' parameter format (JSON objects as string content), it completely omits any explanation of the three required parameters: 'site', 'database_id', and 'collection_id'. The hierarchical relationship between these resources is unexplained, leaving the agent without context for required arguments.

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

Purpose4/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 resource ('documents in a collection'), providing specific scope. However, it fails to distinguish from siblings like 'appwrite_list_documents_paginated' or 'appwrite_search_documents', leaving ambiguity about which listing tool to select. The '[UNIFIED]' prefix adds noise without explanation.

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 guidance is provided on when to use this tool versus the available alternatives (e.g., 'list_documents_paginated', 'search_documents', or 'get_documents_by_ids'). The description lacks explicit when-to-use or when-not-to-use criteria, leaving the agent without selection heuristics.

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

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/airano-ir/mcphub'

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