Skip to main content

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

Project description

AppFlowy MCP

An MCP server for AppFlowy. 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 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.

For self-hosted AppFlowy, also set the base URL:

APPFLOWY_BASE_URL=http://localhost:8000

If omitted, APPFLOWY_BASE_URL defaults to https://beta.appflowy.cloud.

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
  • appflowy_create_markdown_page
  • appflowy_append_markdown_to_page

Page-content support covers appending new document blocks, creating pages from Markdown, and appending Markdown to existing pages. AppFlowy 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"
      }
    ]
  }
}

Example Markdown page:

{
  "parent_view_id": "space-or-page-view-id",
  "title": "Meeting Notes",
  "content": "# Meeting Notes\n\n- [ ] Follow up\n- **Important** decision\n\n```python\nprint(\"hello\")\n```"
}

Markdown conversion supports headings, paragraphs, dividers, bullet lists, numbered lists, todo lists, quotes, code blocks, image links, and inline bold, italic, strikethrough, code, and links.

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, APPFLOWY_PASSWORD, and APPFLOWY_BASE_URL can also be provided through a local .env file.
  • Some page and space endpoints are implemented from AppFlowy 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.3.tar.gz (45.6 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.3-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: appflowy_mcp-0.1.3.tar.gz
  • Upload date:
  • Size: 45.6 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.3.tar.gz
Algorithm Hash digest
SHA256 516415a13a72f6239c7c1cc430a454f6b7610b608b2200527ee492268be98d36
MD5 81405c95f89148380a54a9b264bba9dc
BLAKE2b-256 a766e09072132bb1c45ab0b2fcf2463642c6a5907fef15408957ff9c9dbded81

See more details on using hashes here.

File details

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

File metadata

  • Download URL: appflowy_mcp-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a93b4208e75610c92b753e3770600560dba146cefa9b53fd03c37985cbd048d9
MD5 8e4400b60989da6fd1f263eb3d14807f
BLAKE2b-256 1bf30b6ab59ae8ee8f3e696f58f2a35a8293c082250fbe2df2dff9cca4f8f8b1

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