wflow-mcp

wflow-mcp

Experimental MCP server for the wflow.com public API, enabling natural language operations on documents, registers, users, roles, and teams across one or many organizations.

Category
访问服务器

README

wflow-mcp — experimental MCP server for the wflow.com public API

⚠️ Experimental / proof of concept. Not an official wflow product. Built to explore what Claude can do over the wflow public API. Use against a test/playground organization.

📚 A full offline reference of the wflow public API (all 173 operations + schemas) is bundled at docs/wflow-public-api.md.

A Model Context Protocol server that lets Claude (Desktop, Code, or any MCP client) operate the wflow.com document platform through its public API — read and change documents, registers (cost centres, contracts, …), users, roles and teams, across one or many organizations.

It is built to cover the use cases from the "Využití Claude s wflow API" deck plus the long tail of the API, and it does auth, organization routing, pagination and rate-limit handling for you.


What it can do (mapped to the deck)

Slide Example ask Tools that serve it
Users / roles / teams across orgs "Which users can pay across organizations?" wflow_find_users_with_right (cross-org, defaults to payment rights)
"Replace user Y with X in all organizations" wflow_list_users (allOrganizations) → wflow_upsert_user / wflow_delete_user per org
"Create team X and add these users" wflow_list_userswflow_upsert_team
"Prepare re-invoicing docs for client access" wflow_list_users + wflow_get_user (roles/teams/rights) across orgs
Bulk document changes "Set all documents with order Z01 to cost centre Centrála" wflow_get_register (resolve the code) → wflow_bulk_update_documents
"Import line items from this table into this invoice" wflow_update_document (lines: [...])
"Find documents for these transactions across all orgs" wflow_search_documents (allOrganizations, query)
Controlling / reporting "Find inconsistencies in posting" wflow_search_documents + wflow_get_document / wflow_get_document_events
"Is any cost centre inactive this quarter?" wflow_get_register + wflow_search_documents
"Find deviations vs. the ledger export" wflow_export_documents (datev/excel/…)
"Where is the order for this invoice?" wflow_search_documents (query=orderNo = "…")

Anything not covered by a typed tool is reachable via wflow_request (browse the full surface with wflow_api_catalog) — so the server exposes all 173 API operations.


Tools (26)

Discovery & generic

  • wflow_list_organizations — orgs the principal can access (foundation for cross-org work)
  • wflow_whoami — current account/identity for an org
  • wflow_api_catalog — browse/filter the full endpoint catalog
  • wflow_request — call any endpoint (method, path, org, query, body)

Documents

  • wflow_search_documents — filter/sort/auto-paginate, single or cross-org
  • wflow_get_document · wflow_get_document_events
  • wflow_update_document — create/update; set accounting registers by code, add line items
  • wflow_bulk_update_documents — query → patch every match (dry-run by default)
  • wflow_export_documents — export to ERP/accounting formats (datev, excel, isdoc, money…)
  • wflow_upload_document_file · wflow_create_document_with_files

Registers (cost centres, contracts, activities, chart of accounts, partners, projects, …)

  • wflow_get_register · wflow_upsert_register (PUT = replace set / PATCH = partial)

Users / roles / teams

  • wflow_list_users · wflow_get_user · wflow_upsert_user · wflow_delete_user
  • wflow_find_users_with_right — cross-org "who can do X" (e.g. who can pay)
  • wflow_list_roles · wflow_upsert_role · wflow_delete_role
  • wflow_list_teams · wflow_get_team · wflow_upsert_team · wflow_delete_team

Setup

cd wflow-mcp
npm install
npm run build
cp .env.example .env   # then edit .env

Configure .env

WFLOW_AUTH_MODE=client_credentials
WFLOW_ORG=your-org-slug
WFLOW_CLIENT_ID=your_client_id
WFLOW_CLIENT_SECRET=…
WFLOW_READONLY=false          # set true to block all writes
WFLOW_MAX_ITEMS=2000          # auto-pagination safety cap per org

Verify it works (live smoke test)

npm run smoke

This spawns the server over stdio exactly like a Claude client, lists the tools, does a set of reads, then creates → bulk-updates → verifies → deletes a throwaway document.


Authentication

Two OAuth 2.0 flows, selected by WFLOW_AUTH_MODE:

1. client_credentials (default, machine-to-machine)

Uses WFLOW_CLIENT_ID + WFLOW_CLIENT_SECRET, scope uccl_common_api. The client must be granted access to each organization in wflow → Settings → Integrations → API accesses. This is what the provided _docasny client uses and it works out of the box.

2. interactive (opens the wflow login page — you type your username/password)

Authorization Code + PKCE. Set WFLOW_AUTH_MODE=interactive and WFLOW_CLIENT_ID, then:

npm run login   # opens https://account.wflow.com in your browser

The refresh token is cached in ~/.wflow-mcp/tokens.json, so the server starts without prompting afterwards. With interactive auth, wflow_list_organizations returns every org your account can see — which is what makes the cross-organization use cases shine.

Requirement: the client must be registered in wflow with grant type Authorization code and must whitelist the redirect URI http://localhost:53682/callback. Interactive clients are set up via wflow technical support. The provided _docasny client is client-credentials only, so interactive mode needs a separate interactive client id.


Add to Claude

Claude Desktop / Claude Code (.mcp.json or claude_desktop_config.json)

{
  "mcpServers": {
    "wflow": {
      "command": "node",
      "args": ["/absolute/path/to/wflow-mcp/dist/index.js"],
      "env": {
        "WFLOW_AUTH_MODE": "client_credentials",
        "WFLOW_ORG": "your-org-slug",
        "WFLOW_CLIENT_ID": "your_client_id",
        "WFLOW_CLIENT_SECRET": "PUT-SECRET-HERE",
        "WFLOW_READONLY": "false"
      }
    }
  }
}

(Environment variables set here override .env, and don't depend on the working directory.)

Claude Code (CLI, one-liner)

claude mcp add wflow \
  -e WFLOW_AUTH_MODE=client_credentials \
  -e WFLOW_ORG=your-org-slug \
  -e WFLOW_CLIENT_ID=your_client_id \
  -e WFLOW_CLIENT_SECRET=PUT-SECRET-HERE \
  -- node /absolute/path/to/wflow-mcp/dist/index.js

Then in Claude: "List my wflow organizations", "Which users can pay?", "Set every document with order Z01 to cost centre 123 (dry run first)".


Design notes & safety

  • Hybrid tool surface. High-value typed tools for the deck's workflows + a generic wflow_request for the entire API. The endpoint catalog (src/endpoints.json, 173 ops) is bundled so wflow_api_catalog works offline.
  • Cross-org is first-class. search, list_users, list_teams, find_users_with_right and bulk_update accept organizations: [...] or allOrganizations: true and fan out.
  • Registers by code. Set accounting.costCenter = {code:"123"} (or externalId/id); wflow resolves the register on write — no id lookup needed. (Assigning an invalid register code is silently ignored by wflow.)
  • Dry-run by default. wflow_bulk_update_documents previews matches unless apply=true.
  • Read-only mode. WFLOW_READONLY=true blocks every non-GET request.
  • Pagination. List/search auto-paginate up to WFLOW_MAX_ITEMS per org and report truncated.
  • Rate limits. 429s are retried once, respecting x-rate-limit-period.

Project layout

src/
  config.ts        env + .env loader
  auth.ts          token manager (client_credentials + interactive PKCE)
  client.ts        HTTP client, org resolution, pagination
  util.ts          result helpers + endpoint catalog loader
  endpoints.json   bundled catalog of all 173 API operations
  tools/
    discovery.ts   list_organizations, whoami, api_catalog, request
    documents.ts   search, get, update, bulk_update, events, export, upload, create_with_files
    registers.ts   get_register, upsert_register
    people.ts      users, roles, teams, find_users_with_right
  index.ts         server bootstrap (stdio)
  login.ts         standalone interactive login (npm run login)
scripts/smoke.ts   end-to-end test against the live playground

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选