-
Notifications
You must be signed in to change notification settings - Fork 304
Add Zenflow to MCP integration docs #2719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
starlightknown
wants to merge
6
commits into
appwrite:main
Choose a base branch
from
starlightknown:doc-2701-add-zenflow-to-mcp-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+152
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
21a1ef0
Add Zenflow to MCP docs
karunatata-zen 2ba4973
Merge branch 'main' into doc-2701-add-zenflow-to-mcp-docs
starlightknown 098bebb
Update src/routes/docs/tooling/mcp/zenflow/+page.markdoc
starlightknown 71badcf
Update src/routes/docs/tooling/mcp/zenflow/+page.markdoc
starlightknown 253669d
Update src/routes/docs/tooling/mcp/zenflow/+page.markdoc
starlightknown bcdbcaa
Merge branch 'main' into doc-2701-add-zenflow-to-mcp-docs
adityaoberai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| --- | ||
| layout: article | ||
| title: Appwrite MCP and Zenflow | ||
| description: Learn how to add the Appwrite MCP servers to agents in Zenflow to interact with both the Appwrite API and documentation. | ||
| --- | ||
|
|
||
| Learn how you can add the Appwrite MCP servers to agents in Zenflow to interact with both the Appwrite API and documentation. | ||
|
|
||
| Before you begin, ensure you have the following **prerequisites** installed on your system: | ||
| {% tabs %} | ||
| {% tabsitem #api-server-prerequisites title="API server" %} | ||
|
|
||
| [uv](https://docs.astral.sh/uv/getting-started/installation/) must be installed on your system. | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #docs-server-prerequisites title="Docs server" %} | ||
|
|
||
| [Node.js](https://nodejs.org/en/download) and npm must be installed on your system. | ||
|
|
||
| {% /tabsitem %} | ||
| {% /tabs %} | ||
|
|
||
| {% section #step-1 step=1 title="Add MCP servers" %} | ||
|
|
||
| To add the Appwrite MCP server, open Zenflow and go to the **Settings** > **MCP servers**. From there, select your agent you want to configure MCP for, and then add your custom MCP server. | ||
|
|
||
| {% tabs %} | ||
| {% tabsitem #api-only title="API server" %} | ||
|
|
||
| Update the | ||
| ```json | ||
| { | ||
| "mcpServers": {} | ||
| } | ||
| ``` | ||
| to include the API server: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "appwrite-api": { | ||
| "command": "uvx", | ||
| "args": [ | ||
| "mcp-server-appwrite", | ||
| "--sites" | ||
| ], | ||
| "env": { | ||
| "APPWRITE_PROJECT_ID": "your-project-id", | ||
| "APPWRITE_API_KEY": "your-api-key", | ||
| "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **Configuration:** | ||
| - Replace `your-project-id` with your actual Appwrite project ID | ||
| - Replace `your-api-key` with your Appwrite API key | ||
| - Replace `<REGION>` with your Appwrite Cloud region (e.g., `nyc`, `fra`) | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #docs-only title="Docs server" %} | ||
|
|
||
| Update the | ||
| ```json | ||
| { | ||
| "mcpServers": {} | ||
| } | ||
| ``` | ||
| to include the docs server: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "appwrite-docs": { | ||
| "url": "https://mcp-for-docs.appwrite.io", | ||
| "type": "http" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {% /tabsitem %} | ||
| {% /tabs %} | ||
|
|
||
| Click **Save**. Once you save the configuration, Zenflow will connect with the MCP server(s) and load all available tools. | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-2 step=2 title="Test the integration" %} | ||
|
|
||
| Open **Zenflow Chat** of your existing task to test your MCP integrations. If you don't have an existing task, you can create one by clicking **New Task**, selecting a task type, and writing a task description. Click **Create and Run**. | ||
| If you are new to Zenflow, learn more about [how to set up Zenflow](https://docs.zencoder.ai/user-guides/guides/set-up-your-zenflow#step-6:-create-your-first-task). | ||
|
|
||
| You can try out the following example prompts based on the MCP server you have configured: | ||
|
|
||
| {% tabs %} | ||
| {% tabsitem #test-api title="API server" %} | ||
|
|
||
| **Example prompts:** | ||
| - `Create a new user in my Appwrite project` | ||
| - `List all databases in my project` | ||
| - `Show me the collections in my database` | ||
| - `Create a new document in my collection` | ||
| - `Delete a specific user by ID` | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #test-docs title="Docs server" %} | ||
|
|
||
| **Example prompts:** | ||
| - `How do I set up real-time subscriptions in Appwrite?` | ||
| - `Show me how to authenticate users with OAuth` | ||
| - `What are the best practices for database queries?` | ||
| - `How do I implement file uploads with Appwrite Storage?` | ||
| - `Show me an example of using Appwrite Functions` | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% /tabs %} | ||
|
|
||
|  | ||
|
|
||
|
|
||
| {% /section %} | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update terminology to rows/columns.
The example prompts still use “collections” and “document,” which should be replaced with “columns” and “rows” per the docs terminology update.
✏️ Proposed fix
Based on learnings “In appwrite/website, update terminology to use 'rows' and 'columns' instead of 'documents' and 'collections' across all documentation files with the .markdoc extension, including generated SDK documentation. Ensure consistent usage in content, metadata, and any code samples or schemas.”
📝 Committable suggestion
🤖 Prompt for AI Agents