Skip to main content

BPMN generating MCP server with UI. Built using MCP App extension

Project description

appkit-bpmn-server

An MCP Apps-compliant server that generates, edits, and manages BPMN 2.0 diagrams from natural language — powered by LLMs.

Describe a business process in plain text and get a valid, layouted BPMN diagram with an interactive viewer rendered inline in any MCP Apps-capable host (Claude, ChatGPT, VS Code, etc.).

Screenshot

Features

  • Natural language to BPMN — Generate process diagrams from text descriptions
  • Interactive viewer — Built-in bpmn-js editor with zoom, pan, and editing capabilities
  • Update diagrams — Modify existing diagrams via follow-up prompts without starting over
  • Persistent storage — SQLite-backed diagram storage with Alembic migrations
  • User assignment — Associate diagrams with specific users via x-user-id header or query parameter (defaults to -1)
  • Auto-layout — Automatic swimlane arrangement and edge routing
  • Validation — Generated BPMN XML is validated before storage
  • MCP Apps UI — Inline rendering in any compliant chat host

Architecture

MCP Host (Claude, ChatGPT, …)
  │
  │  MCP over HTTP (stateless)
  ▼
appkit-bpmn-server      ← this repo (configuration + startup)
  │
  ├─ appkit-mcp-bpmn    ← MCP tools, viewer, BPMN generation
  ├─ appkit-commons     ← shared config, OpenAI client, registry
  └─ SQLite database    ← diagram persistence

Prerequisites

  • Python 3.14+
  • uv package manager
  • An OpenAI-compatible API key (Azure OpenAI or OpenAI)

Getting Started

1. Clone and install

git clone https://github.com/jenreh/appkit-bpmn-server.git
cd appkit-bpmn-server
uv sync

2. Configure environment

Create a .env file in the project root:

OPENAI_API_KEY=your-api-key
OPENAI_BASE_URL=https://your-endpoint.openai.azure.com/v1

3. Run database migrations

uv run alembic upgrade head

4. Start the server

uv run appkit_bpmn_server

The MCP endpoint will be available at http://127.0.0.1:8000/mcp.

5. Connect from an MCP client

Add the server to your MCP client configuration:

{
  "mcpServers": {
    "bpmn": {
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

MCP Tools

Tool Description
new_bpmn_diagram Generate a new BPMN diagram from a natural language description
update_bpmn_diagram Modify an existing diagram using a follow-up prompt
save_bpmn_diagram Save pre-built BPMN XML
get_bpmn_xml Retrieve the BPMN XML for a diagram (app-only)
save_or_update Persist edits made in the viewer (app-only)
rename_bpmn_diagram Rename a diagram (app-only)

Tools marked app-only are hidden from the model and callable only from the interactive viewer.

Configuration

Server settings are in configuration/config.yaml:

app:
  mcp_bpmn:
    storage_mode: database          # database, filesystem, or both
    default_model: gpt-5.3-codex    # LLM model for generation
    max_file_size_mb: 10
    diagram_types:
      - process

User Assignment

Diagrams can be associated with a specific user by sending an x-user-id value. This can be provided as:

  • HTTP header: x-user-id: 123
  • Query parameter: ?x-user-id=123

If neither is provided, the user ID defaults to -1.

Project Structure

├── configuration/
│   ├── config.yaml          # Development configuration
│   ├── config.prod.yaml     # Production overrides
│   └── logging.yaml         # Logging configuration
├── alembic/                 # Database migrations
├── src/
│   └── appkit_bpmn_server/
│       └── main.py          # Server entry point
├── pyproject.toml
└── .env                     # API keys (not committed)

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

appkit_bpmn_server-0.1.2.tar.gz (500.7 kB view details)

Uploaded Source

Built Distribution

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

appkit_bpmn_server-0.1.2-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file appkit_bpmn_server-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for appkit_bpmn_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b9f563fbbea779b446c7daf894aa8340d967d4fde5eb594517f6bd519e25549d
MD5 de2aa4daaa49516af75770c9d18bb83a
BLAKE2b-256 3301a652ff04746cbdbec97d0d1e235b1b714d5a605df27583882b0b19466923

See more details on using hashes here.

File details

Details for the file appkit_bpmn_server-0.1.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for appkit_bpmn_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d5f8f08156718d6b2741e618b3582a52d7125bfde1a6ebfd0d7fbec6c57838f6
MD5 78c893868b1b57efb5c37859c3a87998
BLAKE2b-256 2d17b6b7af3b0b956d48b2e7b0d2cd97bdc0630c37a309a4135e709b204fff85

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