Skip to content
ProductivityQuality Score: 46/99 (Fair)No Auth RequiredSpec v0.9.3auto GenerationTransport: stdio

Appwrite ClientMCP Configuration & Schema Registry

The Appwrite Client Model Context Protocol (MCP) configuration provides a validated, machine-readable JSON schema and executable bridge that connects state-of-the-art AI coding assistants — including Claude Desktop, Cursor IDE, Windsurf, Cline, and VS Code Copilot — directly to the Appwrite Client REST API. By leveraging the standardized open Model Context Protocol, AI agents can dynamically discover capabilities, validate input parameters against strict JSON Schemas, and execute live API operations without context switching or manual copy-pasting.

Quick Specs & Integration Summary

1. Functionality:Exposes 10 API endpoints as callable AI tools for Appwrite Client.
2. Authentication:Zero authentication required — ready for immediate execution.
3. Protocol Layer:Standard Model Context Protocol JSON-RPC 2.0 via stdio transport.
4. Quick Launch:npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json

Technical Architecture & Protocol Semantics

Under the Model Context Protocol specification, the Appwrite Client configuration functions as an isolated protocol adapter. When an AI agent initializes a session, the client establishes a bidirectional JSON-RPC 2.0 communication channel over standard input/output (stdio) or Server-Sent Events (SSE). During the initial handshake, the server publishes its tool manifest extracted from the Appwrite Client OpenAPI specification (version 0.9.3).

The Appwrite Account API represents a core component of the Appwrite Backend-as-a-Service (BaaS) platform, designed to radically accelerate development by managing the complete lifecycle of user accounts through a simplified RESTful interface. Provided by Appwrite, an open-source, self-hosted backend server, this API abstracts complex user management logic into a series of secure endpoints. It handles essential operations including creating and deleting accounts (POST /account, DELETE /account), updating core profile details like email, name, and password (PATCH /account/email, PATCH /account/name, PATCH /account/password), and managing authentication sessions and JSON Web Tokens (POST /account/jwt). Furthermore, it provides access to user activity logs (GET /account/logs) and allows for the storage and retrieval of arbitrary user preferences (GET /account/prefs, PATCH /account/prefs). Typical use cases span from simple mobile applications needing quick user signup to enterprise platforms requiring robust, self-service account administration, with Appwrite handling the secure storage, session management, and verification processes that would otherwise demand significant custom backend development. When this Account API is exposed as tools to an AI coding assistant via the Model Context Protocol (MCP), it transforms the assistant from a code generator into an interactive development and operations partner. The AI gains direct, safe, and contextual awareness of the application's user management backend. Instead of just describing how to write an API call, the assistant can execute the actual operations in real-time. This integration offers profound value by enabling dynamic, context-aware assistance: the AI can verify that a user registration endpoint it helped create is functioning correctly by making a test POST /account call, or it can update its understanding of the user schema by fetching current preferences via GET /account/prefs. This turns theoretical suggestions into actionable, verified insights, drastically reducing iteration cycles and ensuring the generated code aligns perfectly with the live backend state. This MCP integration unlocks a range of practical, dynamic workflow examples for developers. A developer can instruct the AI agent to perform diagnostic tasks such as "Query the account logs for user X via GET /account/logs to audit their recent authentication attempts and identify anomalies." For automation, the agent can be directed to "Update the administrative user's contact email using PATCH /account/email to reflect the new corporate domain," or "Bulk-update a user's preference flags using PATCH /account/prefs to enable a new beta feature for testing." During development, the AI can facilitate scaffolding and testing by being told, "Create a test account with these credentials using POST /account to validate the onboarding flow, then delete it with DELETE /account to clean up the environment." These interactions allow the developer to manage, test, and debug their application's user system through natural language commands, with the AI acting as a direct conduit to the backend. Critical to leveraging this capability is a rigorous adherence to authentication and security best practices. Although the basic API description notes "None" for authentication, this refers to the public, unauthenticated endpoints for account creation. In practice, all operations targeting an existing user's account (GET, PATCH, DELETE) must be authenticated, typically using the JWT obtained via POST /account/jwt. When configuring this MCP server, developers must implement secure credential management, ensuring API keys or session tokens are not exposed in client-side code or logs. The principle of least privilege should be enforced, granting the AI agent only the specific permissions required for its intended tasks (e.g., read-only access to logs vs. full account modification rights). It is essential to treat the AI assistant as a privileged actor within the system, employing rate limiting, thorough input validation on all parameters the AI might supply, and comprehensive audit logging of every AI-initiated action to maintain security and compliance. This architecture guarantees strict process boundary isolation: all sensitive authorization headers and secret tokens remain sandboxed inside the client runtime, never leaking into language model context windows or external logging endpoints.

Authentication TypePublic (No Auth)Injected via local client environment
Tools & Routes Mapped10 OperationsConforms to JSON-RPC 2.0 specs
Specification OriginOpenAPI v0.9.3auto schema validation
Documentation & Schema Quality Index
46
★ Grade C - Baseline Coverage
Automated Audit Checklist
Automated schema extraction & validation (+12 pts)
Extensive tool mapping (10 endpoints defined) (+20 pts)
Zero-configuration public API instant execution (+20 pts)
Full JSON-RPC 2.0 Model Context Protocol specification conformity (+15 pts)
Upstream technical documentation verification (+12 pts)

Hosted Remote Configuration URL

MCP Configuration File

Provide this hosted URL in any client that supports remote MCP schema auto-loading.

https://mcpbridge.org/config/appwrite-io-client.json

2. AI Assistant Use Cases & Practical Workflows

Tailored for Productivity

Real-world execution scenarios demonstrating how LLM agents (Claude 3.7, GPT-4o, Cursor Agent) invoke Appwrite Client tools to automate developer workflows.

1. Automated Incident Escalation & Notification Routing

Incident Comms

Broadcast priority notifications with rich incident context, system health metrics, and on-call engineer assignment details.

Example Natural Language Prompt:

"Dispatch a high-priority incident notification via Appwrite Client containing the latest stack trace, affected microservice names, and link to the active monitoring dashboard."

Mapped: /account

2. Knowledge Base & Workspace Documentation Sync

Knowledge Sync

Synchronize newly merged pull request documentation and architectural decision records into searchable workspace hubs.

Example Natural Language Prompt:

"Fetch updated technical notes from our repository and sync them into Appwrite Client. Ensure headers, code blocks, and parameter tables are correctly formatted in markdown."

Mapped: /account

3. Omnichannel Customer Ticket Triaging & Sentiment Analysis

Support Automation

Classify incoming customer inquiry tickets, detect customer sentiment urgency, and auto-draft contextual solution proposals.

Example Natural Language Prompt:

"Retrieve open customer support tickets from Appwrite Client. Classify urgency based on customer sentiment and generate drafted reply outlines for Tier-2 engineering review."

Autonomous Agent Loop

4. Scheduled Webhook Dispatch & Event Orchestration

Event Orchestration

Automate event notification triggers when deployments complete, staging builds pass, or schema changes are detected.

Example Natural Language Prompt:

"Configure an event notification hook in Appwrite Client to trigger Slack updates whenever a high-severity deployment event is logged in staging."

Autonomous Agent Loop

End-to-End Multi-Step Agent Execution Lifecycle

When an engineer submits a task to Claude Desktop or Cursor, the LLM executes an autonomous 4-phase Model Context Protocol loop:

Phase 1

Schema Introspection

Handshake lists all 10 tools and builds argument validators.

Phase 2

Argument Synthesis

Model extracts parameters from prompt and validates types against OpenAPI rules.

Phase 3

Stdio Execution

Bridge invokes live API with injected local credentials and captures raw HTTP response.

Phase 4

Output Remediation

LLM parses JSON results, handles status codes, and presents synthesized answers.

3. Multi-Client Installation Matrix & Setup Guides

Select your AI assistant below to view exact configuration file paths, JSON installation snippets, and launch commands.

Claude Desktop

claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "appwrite-io-client": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-openapi",
        "https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"
      ],
      "env": {
        "APPWRITE_API_KEY": "your_appwrite_api_key"
      }
    }
  }
}
Deep link

Cursor IDE

.cursor/mcp.json

Open Cursor Settings → Features → MCP Servers, or create .cursor/mcp.json in your project root.

{
  "mcpServers": {
    "appwrite-io-client": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-openapi",
        "https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"
      ],
      "env": {
        "APPWRITE_API_KEY": "your_appwrite_api_key"
      }
    }
  }
}

Saves as .cursor/mcp.json in the download. Move it to your project root.

Deep link install →

VS Code / Cline Extension

cline_mcp_settings.json

Paste into your Cline extension MCP configuration or Roo Code host settings.

{
  "mcpServers": {
    "appwrite-io-client": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-openapi",
        "https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"
      ],
      "env": {
        "APPWRITE_API_KEY": "your_appwrite_api_key"
      }
    }
  }
}

Zed Editor & Docker CLI

Zed / Docker

Docker container execution command:

docker run -i --rm -e APPWRITE_API_KEY="YOUR_SECRET_VALUE" node:20-alpine npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json

Zed settings context servers JSON:

{
  "context_servers": {
    "appwrite-io-client": {
      "command": {
        "path": "npx",
        "args": [
          "-y",
          "@modelcontextprotocol/server-openapi",
          "https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"
        ],
        "env": {
          "APPWRITE_API_KEY": "your_appwrite_api_key"
        }
      }
    }
  }
}

Programmatic SDK Integration (TypeScript / Python)

Initialize the Appwrite Client MCP client directly in your backend codebase.

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

// Initialize Appwrite Client MCP client transport over stdio
const transport = new StdioClientTransport({
  command: "npx",
  args: ["-y","@modelcontextprotocol/server-openapi","https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"],
  env: { APPWRITE_API_KEY: process.env.APPWRITE_API_KEY || "YOUR_SECRET_KEY" }
});

const client = new Client(
  { name: "appwrite-io-client-client", version: "1.0.0" },
  { capabilities: { tools: {}, resources: {}, prompts: {} } }
);

async function connectAndRun() {
  await client.connect(transport);
  const tools = await client.listTools();
  console.log("Connected to Appwrite Client MCP Server.");
  console.log("Discovered 10 mapped tools:", tools);
}

connectAndRun().catch(console.error);

Raw Stdio Schema Definition

schema.json

For standalone CLI wrappers, background daemon daemons, or custom script integrations:

{
  "mcpServers": {
    "appwrite-io-client": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-openapi",
        "https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json"
      ],
      "env": {
        "APPWRITE_API_KEY": "your_appwrite_api_key"
      }
    }
  }
}

4. Security, Authentication & Credential Management

Safely configure authentication tokens, isolate execution environments, and implement enterprise security best practices.

Required Environment Keys Reference

Variable NameRequiredTypeDefaultPurpose & Guidance
APPWRITE_API_KEYREQUIREDSecret Key / TokenNone (Set in env)your_appwrite_api_key

Zero-Downtime Token Rotation Protocol

  1. Generate Secondary Key: Create a new secret API token with identical scopes in your Appwrite Client developer portal.
  2. Update Client Configuration: Insert the new token inside the env block of your MCP client JSON config.
  3. Validate Connection: Issue a test query in Claude or Cursor to ensure handshake and tool calls succeed.
  4. Revoke Stale Token: Decommission the legacy key on the vendor portal to prevent unauthorized access.

Least-Privilege & Sandboxing Rules

  • Read-Only Token Scoping: Whenever your workflow only requires querying data, provision read-only credentials to prevent accidental mutations.
  • Local Process Isolation: Stdio transports run in isolated local subprocesses; secret credentials are never sent across the internet to MCP Bridge servers.
  • Prompt Injection Defense: AI model responses are sandboxed; verify generated destructive arguments before confirming execution in agent mode.

Enterprise Security Checklist (Mandatory Practices)

  • Never commit claude_desktop_config.json or .cursor/mcp.json containing raw secrets into public GitHub repositories.
  • Add .cursor/mcp.json and .env.local to your project's .gitignore file.
  • Always enforce TLS/HTTPS encryption on outbound network requests initiated by the server process.

5. Tool Parameter Schemas & Natural Language Execution

Mapped OpenAPI operations converted into discrete Model Context Protocol tools with strict JSON-RPC payload validators.

10 Total Tools Mapped
GET/account
tools/call: appwrite-io-client_get_account

Get Account

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_get_account",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Get Account and output the formatted result."

POST/account
tools/call: appwrite-io-client_post_account

Create Account

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_post_account",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Create Account and output the formatted result."

DELETE/account
tools/call: appwrite-io-client_delete_account

Delete Account

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_delete_account",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Delete Account and output the formatted result."

PATCH/account/email
tools/call: appwrite-io-client_patch_account_email

Update Account Email

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_patch_account_email",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Update Account Email and output the formatted result."

POST/account/jwt
tools/call: appwrite-io-client_post_account_jwt

Create Account JWT

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_post_account_jwt",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Create Account JWT and output the formatted result."

GET/account/logs
tools/call: appwrite-io-client_get_account_logs

Get Account Logs

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 6,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_get_account_logs",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Get Account Logs and output the formatted result."

PATCH/account/name
tools/call: appwrite-io-client_patch_account_name

Update Account Name

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 7,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_patch_account_name",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Update Account Name and output the formatted result."

PATCH/account/password
tools/call: appwrite-io-client_patch_account_password

Update Account Password

Zero required query/path parameters for this endpoint.
JSON-RPC 2.0 Request Payload
{
  "jsonrpc": "2.0",
  "id": 8,
  "method": "tools/call",
  "params": {
    "name": "appwrite-io-client_patch_account_password",
    "arguments": {}
  }
}
Natural Language Prompt

"Use Appwrite Client to execute Update Account Password and output the formatted result."

6. Interactive Troubleshooting & FAQ Accordion

Diagnose and resolve common JSON-RPC protocol error codes, connection disconnects, and schema refresh issues.

A 401 Unauthorized response indicates that the upstream Appwrite Client API rejected the authentication credential supplied in your MCP client's environment configuration. To resolve this: (1) Verify that your secret token is defined inside the "env" block of claude_desktop_config.json or .cursor/mcp.json rather than hardcoded in the command string. (2) Check whether Appwrite Client requires a prefix such as "Bearer <token>" in the authorization header. (3) Confirm that your API key has not expired and has been granted sufficient least-privilege scopes on the Appwrite Client developer dashboard.

If your MCP client fails to initialize tools for Appwrite Client: (1) Test the bridge launcher command ("npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json") directly inside your terminal or shell to inspect stdout/stderr diagnostic traces. (2) Verify network connectivity to the schema source (https://api.apis.guru/v2/specs/appwrite.io/client/0.9.3/openapi.json). (3) Ensure Node.js (v18+) is installed and accessible in your system PATH. (4) For authenticated APIs, confirm credentials are configured in your client's "env" mapping rather than command arguments.

Similar Productivity Configurations

Explore related API bridges with ready-to-use Model Context Protocol schemas.

Notion

Productivity

Create and manage Notion pages, databases, and blocks through your AI agent.

https://mcpbridge.org/config/notion.json

Linear API

Productivity

Manage issues, projects, and workflows in Linear through your AI agent.

https://mcpbridge.org/config/linear.json

Platform API

Productivity

The Platform API is a comprehensive RESTful interface provided by Ably, a leading provider of real-time messaging and presence infrastructure, designed to give developers granular, programmatic control over their Ably applications and resources. Its core capabilities extend beyond simple pub/sub messaging, enabling the management and inspection of channels, the retrieval and publishing of messages, the manipulation of presence state for users across those channels, and the configuration of push notification subscriptions. Typical use cases span enterprise and consumer applications where real-time functionality is critical, such as live activity feeds for e-commerce platforms, collaborative tools requiring synchronized state, multi-user gaming, real-time chat, and IoT device status monitoring. This API serves as the foundational control plane for any application built on the Ably ecosystem, allowing for dynamic, server-side orchestration of real-time behaviors. When exposed as tools via the Model Context Protocol (MCP) to an AI coding assistant like Claude Desktop, Cursor, or Cline, this API gains transformative value. It transitions from a static endpoint reference to an interactive, queryable system that an AI agent can leverage to understand, debug, and extend a developer's real-time infrastructure. The AI can perform live introspection of channel activity, diagnose presence synchronization issues, or audit message flow without requiring the developer to manually construct complex cURL commands or navigate dashboards. This integration effectively turns the AI into a knowledgeable collaborator with direct, safe access to the operational state of the real-time layer, significantly accelerating troubleshooting, prototyping, and implementation of features that interact with or rely upon the messaging backbone. In practice, a developer can instruct the AI agent to perform a variety of dynamic, context-aware tasks. For instance, one might ask, "AI agent, query the recent messages on the 'user-updates' channel and summarize the last ten status changes," enabling rapid analysis of event streams. Another directive could be, "AI agent, create a new, private channel named 'group-chat-123' and configure its presence history retention to 24 hours," automating infrastructure setup. The AI can also be tasked to "check all active presence members on the 'dashboard' channel to verify if the test user is connected" for debugging, or to "remove a spam message with ID 'msg_abc' from the 'announcements' channel" for moderation. Furthermore, the AI can facilitate push notification management with commands like, "AI agent, list all device subscriptions for the 'breaking-news' channel and remove any that haven't been active in over 30 days," thus maintaining a clean and effective push subscriber list. Security and proper configuration are paramount when deploying this MCP server. Although the API specification lists authentication as "None," this refers to the public REST spec; in practice, all calls require authentication via an Ably API key or token. Developers must follow the principle of least privilege by generating scoped API keys specifically for the AI assistant tool. Keys should be assigned only the capabilities necessary for the intended tasks—such as "subscribe" and "publish" for message reading, or "channel-details" for introspection—and assigned only to the required channels or namespaces. Environment variables should be used to manage these credentials, never hardcoded. It is critical to deploy this MCP server in a secure environment and consider that enabling write operations (POST/DELETE) grants the AI agent the ability to modify state; thus, such tools should be enabled judiciously, potentially limited to development or staging environments, and always with full audit logging enabled to track AI-initiated actions.

https://mcpbridge.org/config/ably-io-platform.json

Control API v1

Productivity

The Control API v1, provided by Ably, is a comprehensive programmatic interface designed for the administrative management and automation of Ably’s real-time messaging infrastructure. It serves as the central nervous system for controlling core resources within an Ably account, enabling developers and platform engineers to dynamically provision and configure applications, manage authentication credentials (keys), organize message flow with namespaces, and establish operational rules. Its primary function is to transition infrastructure management from manual, dashboard-driven tasks to scalable, code-first operations. This makes it indispensable for enterprise use cases such as automated environment provisioning for development and testing, multi-tenant SaaS platforms requiring isolated customer channels, and large-scale IoT deployments where device groups (represented by namespaces) or security credentials (keys) must be managed programmatically in response to dynamic demand. The API currently operates in a Beta state, indicating it is feature-rich but subject to refinement based on developer feedback. When integrated as tools for an AI coding assistant via the Model Context Protocol (MCP), the Control API unlocks a powerful paradigm of infrastructure-as-conversation, dramatically accelerating development workflows and reducing context-switching. An AI agent, armed with these tools, becomes a co-pilot capable of directly querying and modifying your Ably topology based on natural language instructions. This transforms abstract architectural decisions into immediate, executable actions. For instance, a developer can instruct the AI to "list all applications in our account and generate a new API key scoped to the 'production' namespace for the payments service," bypassing manual dashboard navigation and potential configuration errors. The value lies in the AI's ability to understand context, chain operations (e.g., "find the app ID for 'user-service', then list its keys, and finally create a new key with read-only permissions"), and act as a contextual expert, thereby compressing development cycles and enhancing operational accuracy. Practical workflows enabled by this MCP server are numerous and directly impactful. An AI agent can perform dynamic resource auditing by querying all keys and their permissions to generate a security report, stating, "AI agent can query all keys to audit privilege distribution across namespaces." It can automate environment cleanup by instructing, "AI agent can delete all test namespaces older than 30 days to reduce clutter and costs." In a CI/CD pipeline context, a developer could prompt, "AI agent can create a temporary, restricted key for a staging environment and then revoke it after tests complete," ensuring ephemeral credentials and enforcing security hygiene. For multi-tenant management, the AI can handle customer onboarding by executing, "AI agent can create a new namespace for a new tenant, generate a scoped key, and provide the configuration details back to the provisioning system." Critical to the deployment of this API is the absence of a built-in authentication method, which mandates that developers implement and enforce robust security controls externally. Authentication and authorization must be rigorously applied, ideally using Ably API keys with the smallest possible set of privileges required for the specific task, adhering strictly to the principle of least privilege. For an MCP server integration, this means the server should be configured with a high-privilege key only in a secure, isolated backend environment, while exposing a minimal set of safe, well-vetted tools to the AI. Additional security best practices include using short-lived tokens where possible, enforcing IP allowlists on API keys, and meticulously logging all API actions for audit trails. Developers must treat the Control API as a powerful and sensitive management plane, where a misconfigured tool or overly broad permission could lead to significant operational or security incidents.

https://mcpbridge.org/config/ably-net-control.json