Skip to main content

AppFlowy Cloud MCP server for workspace, space, page, database, and row operations

Project description

AppFlowy MCP

An MCP server for AppFlowy Cloud. This fork adds workspace folder, space, page, trash, favorite, and basic page-content tools on top of the original workspace/database/row tools.

Requirements

  • Python 3.14
  • uv
  • AppFlowy Cloud account credentials

Configure In Codex

Option 1: PyPI / uvx

Use this after the package is published to PyPI. This is the simplest setup for daily use.

Use uvx as the command:

uvx

Use these arguments:

appflowy-mcp

Option 2: Local Source / uv

Use this when developing the MCP locally or running directly from a cloned repository.

Use uv as the command:

uv

Use these arguments:

run
--project
D:\codes\MCP\Appflowy-MCP
D:\codes\MCP\Appflowy-MCP\main.py

Environment Variables

Set these environment variables:

APPFLOWY_EMAIL=your-email@example.com
APPFLOWY_PASSWORD=your-password

With these variables set, tools automatically log in on first use. appflowy_login is still available when you want to provide credentials explicitly.

AppFlowy Structure

Most write operations need both a workspace and a parent view:

workspace -> space -> page/database

To create a page inside a space, pass the workspace ID and use the space view_id as parent_view_id.

Tools

Authentication

  • appflowy_login
  • appflowy_refresh_token

Workspaces And Spaces

  • appflowy_list_workspaces
  • appflowy_get_workspace_folder
  • appflowy_list_spaces
  • appflowy_create_space
  • appflowy_update_space

Pages

  • appflowy_create_page
  • appflowy_get_page
  • appflowy_update_page
  • appflowy_move_page_to_trash
  • appflowy_restore_page_from_trash
  • appflowy_delete_page_from_trash
  • appflowy_favorite_page
  • appflowy_list_trash
  • appflowy_list_favorites

Page Content

  • appflowy_append_text_to_page
  • appflowy_append_blocks_to_page

Page-content support currently covers appending new document blocks. AppFlowy Cloud exposes a high-level append-block endpoint, but not a matching high-level REST endpoint for deleting or editing arbitrary existing blocks. Page-level deletion through trash is supported.

Example paragraph block:

{
  "type": "paragraph",
  "data": {
    "delta": [
      {
        "insert": "Hello from MCP"
      }
    ]
  }
}

Databases And Rows

  • appflowy_list_databases
  • appflowy_get_database_fields
  • appflowy_list_rows
  • appflowy_get_row_details
  • appflowy_create_row
  • appflowy_upsert_row
  • appflowy_get_updated_rows

Local Run

uv run appflowy-mcp

Publish To PyPI

Build and check the package:

uv build
uv publish --dry-run --trusted-publishing never

Publish with a PyPI API token:

$env:UV_PUBLISH_TOKEN="pypi-your-token"
uv publish --trusted-publishing never

Do not commit PyPI tokens or write them into project files.

Notes

  • Tokens are stored in memory by the MCP server process.
  • APPFLOWY_EMAIL and APPFLOWY_PASSWORD can also be provided through a local .env file.
  • Some page and space endpoints are implemented from AppFlowy Cloud source routes that are not present in the public OpenAPI document.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appflowy_mcp-0.1.1.tar.gz (42.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

appflowy_mcp-0.1.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file appflowy_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: appflowy_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 42.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for appflowy_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 85d11ed21e121c45802be255492be1e9a48d1a6e6be1e2b4a622dd822a117e9b
MD5 3900819d9107f26117bde552a1dc47dd
BLAKE2b-256 3d2e3df3c62c6d29adc71182a3b8dfd8eed1fe9b729ddf5f3baefa95c62c8e2d

See more details on using hashes here.

File details

Details for the file appflowy_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: appflowy_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for appflowy_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8f1e460625224f70d2ff4614ffe5e1dfc49e0cbc9f797c31f3f62fa826ec5bc5
MD5 33c619cc60782322be150cb0e75c8090
BLAKE2b-256 be7c33867040135ff17bdc07ac3ee3d4f9627a7a55c052cff251595e54356720

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page