Workflows Mcp Server

io.github.cyanheads由 GitHub 账号 cyanheads 发布v0.5.0更新于 Oct 29, 2026

Store, query, and create YAML workflow playbooks for LLM agents.

概览

AI 生成的概览

本地 MCP 服务器,从文件目录中存储、列出、读取、创建和删除供 LLM 智能体使用的带版本 YAML 工作流剧本。

可以做什么
  • 按关键词、分类和标签筛选列出永久工作流,可选择显示每个工作流用到的 server/tool 组合
  • 按名称和可选的 semver 版本获取完整工作流定义,并附带库的全局指令
  • 在分类目录下以 YAML 文件创建永久工作流,包含名称、版本、描述、作者和步骤
  • 创建临时草稿工作流,可被读取但不会出现在列表中
  • 在用户确认解析出的名称、版本和文件后删除永久工作流或草稿
  • 通过防抖的文件系统监听器自动感知 YAML 文件的修改
适用场景
适合希望智能体跨会话复用由 MCP server/tool 调用组成的多步骤剧本、把这些剧本以可读且可纳入版本管理的 YAML 保存在磁盘上,并临时起草一次性工作流而不弄乱永久库的场景。
运行要求
本地运行,支持 stdio(或 Streamable HTTP)。需要 Bun v1.4.0 以上或 Node.js v24 以上,可通过 npx、bunx 或 Docker 安装。需要一个本地 YAML 工作流目录,由 WORKFLOWS_DIR 指定(默认 ./workflows-yaml)。无需 API 密钥。可选配置包括 GLOBAL_INSTRUCTIONS_PATH、WATCHER_DEBOUNCE_MS、MCP_TRANSPORT_TYPE、MCP_HTTP_PORT、MCP_AUTH_MODE 和 MCP_LOG_LEVEL。
安装前请注意
服务器会写入和删除所配置工作流目录中的文件,请把 WORKFLOWS_DIR 指向愿意被修改的目录。删除需要客户端支持 elicitation 确认,否则无法删除任何内容。HTTP 部署时应设置 MCP_REQUEST_STATE_KEY 以密封确认状态,并注意无状态会话模式会被拒绝。启用 LOG_TOOL_FAILURE_PAYLOADS 会记录失败调用的参数和结果,自由文本值中的密钥不会被脱敏。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Workflows Mcp Server,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@cyanheads/workflows-mcp-server

Store, query, and create YAML workflow playbooks for LLM agents via MCP. STDIO or Streamable HTTP.

5 Tools


Overview

A declarative workflow library for LLM agents, backed by local YAML files. Store, list, and retrieve named, versioned multi-step playbooks — each a sequence of MCP server/tool calls — for permanent reuse or one-shot temporary runs. Edits to the YAML files are picked up automatically.

Tools

ToolDescription
workflow_listList all permanent workflows in the index, with optional keyword, category, and tag filters.
workflow_getRetrieve a complete workflow definition by name, with the library's global instructions included.
workflow_createWrite a new permanent workflow YAML to the library.
workflow_create_tempWrite a temporary workflow draft, indexed but excluded from list results, kept until deleted.
workflow_deleteRemove a permanent workflow or a temporary draft by name and optional version, after the user confirms the resolved target.

Capability reference

workflow_list tool

  • Optional query (name and description), category (substring), and tags (all must match) filters, case-insensitive; temporary drafts are never listed
  • Sorted by name, then highest version first; an empty result carries a notice echoing the applied filters
  • includeTools: true adds each workflow's unique server/tool pairs

workflow_get tool

  • name plus an optional semver version; omit version for the highest available, drafts included
  • Returns the full workflow, its source (permanent or temp), and globalInstructions from global_instructions.md (null when absent); fails with not_found or version_not_found
  • Template placeholders such as {{input.foo}} come back verbatim — the server never interpolates them

workflow_create tool

  • name, semver version, description, author, category, and steps (plus optional tags); stored as one file per name@version under categories/<category>/, with created and updated dates stamped
  • Returns the key (name@version) and filePath; fails with already_exists when a permanent workflow or a draft holds the key, invalid_input, or write_failed

workflow_create_temp tool

  • The workflow_create fields minus category; stored under temp/, retrievable with workflow_get, never listed, and kept until workflow_delete removes it
  • status is created, or overwritten when it replaced the draft of the same key (keeping that draft's created_date); a key held by a permanent workflow fails with already_exists

workflow_delete tool

  • name plus an optional version (omitted: the highest across permanent workflows and drafts); the user confirms the resolved name@version, source, and file before anything is deleted, so a client without elicitation cannot delete
  • Returns the deleted workflow's source, plus a notice when another file declaring the same key now takes its place; fails with cancelled, confirmation_invalid (a prompt never issued, already answered, older than 10 minutes, or issued to another caller), target_changed (the file or its content changed after the user saw it), or not_found

Features

Built on @cyanheads/mcp-ts-core: stdio and Streamable HTTP transports, pluggable auth (none / jwt / oauth), swappable storage (in-memory, filesystem, Supabase, Cloudflare KV/R2/D1), structured logging with optional OpenTelemetry tracing.

Workflow library:

  • YAML files under categories/ and temp/ are validated at index time; an invalid file is skipped and logged, never crashes the server
  • In-memory index keyed by name@version, read from each file's content rather than its name and kept fresh by a debounced recursive watcher; a permanent workflow outranks a draft with the same key
  • Versions are canonical semver everywhere: a leading v, surrounding whitespace, and build metadata are dropped, so v1.0.0+build.5 is stored, keyed, and looked up as 1.0.0
  • Creates and deletes run one at a time, so each existence check holds until its write lands; filenames carry a hash of name@version, so keys whose slugs coincide never share a file
  • An _index.json snapshot is written on every rebuild for external tooling and debugging

Agent-friendly output:

  • Discriminated output — source: "permanent" | "temp" on every workflow_get response and typed reason codes (not_found, version_not_found, already_exists, cancelled, confirmation_invalid, target_changed, index_unavailable, …) on failures, so callers branch on data instead of parsing error strings
  • No extra round trip — workflow_get always returns globalInstructions alongside the workflow definition in the same response
  • Response shaping — workflow_list's optional includeTools flag pre-derives the unique server/tool pairs used by a workflow, and an empty result echoes the applied filters with a broadening hint instead of returning nothing

Getting started

No API keys required. The server reads from a local workflows-yaml/ directory by default.

Add the following to your MCP client configuration file:

json
{  "mcpServers": {    "workflows-mcp-server": {      "type": "stdio",      "command": "bunx",      "args": ["@cyanheads/workflows-mcp-server@latest"],      "env": {        "MCP_TRANSPORT_TYPE": "stdio",        "WORKFLOWS_DIR": "/absolute/path/to/your/workflows-yaml"      }    }  }}

Or with npx (no Bun required):

json
{  "mcpServers": {    "workflows-mcp-server": {      "type": "stdio",      "command": "npx",      "args": ["-y", "@cyanheads/workflows-mcp-server@latest"],      "env": {        "MCP_TRANSPORT_TYPE": "stdio",        "WORKFLOWS_DIR": "/absolute/path/to/your/workflows-yaml"      }    }  }}

Or with Docker:

json
{  "mcpServers": {    "workflows-mcp-server": {      "type": "stdio",      "command": "docker",      "args": [        "run", "-i", "--rm",        "-e", "MCP_TRANSPORT_TYPE=stdio",        "-v", "/absolute/path/to/your/workflows-yaml:/workflows-yaml",        "-e", "WORKFLOWS_DIR=/workflows-yaml",        "ghcr.io/cyanheads/workflows-mcp-server:latest"      ]    }  }}

For Streamable HTTP, set the transport and start the server:

sh
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http# Server listens at http://localhost:3010/mcp

Seed workflows

The repository ships a workflows-yaml/ directory with example workflows organized under categories/. These are ready to use as a starting point. The workflows-yaml/global_instructions.md file contains instructions the server includes in every workflow_get response (the globalInstructions field) — edit it to set global guidance for your agent.

Prerequisites

  • Bun v1.4.0 or higher (or Node.js v24+).
  • A local directory containing YAML workflow files (or use the bundled workflows-yaml/ seed).

Installation

  1. Clone the repository:
sh
git clone https://github.com/cyanheads/workflows-mcp-server.git
  1. Navigate into the directory:
sh
cd workflows-mcp-server
  1. Install dependencies:
sh
bun install
  1. Configure environment:
sh
cp .env.example .env# edit .env if needed — most settings have defaults

Configuration

VariableDescriptionDefault
WORKFLOWS_DIRAbsolute or relative path to the workflows root directory../workflows-yaml
GLOBAL_INSTRUCTIONS_PATHPath to the global instructions markdown file. Derives from WORKFLOWS_DIR when not set.<WORKFLOWS_DIR>/global_instructions.md
WATCHER_DEBOUNCE_MSInteger milliseconds (0–2147483647) to debounce filesystem change events before rebuilding the index.500
MCP_TRANSPORT_TYPETransport: stdio or http.stdio
MCP_HTTP_PORTPort for HTTP server.3010
MCP_SESSION_MODEHTTP sessions: auto or stateful. workflow_delete's confirmation prompt needs a live session, so HTTP startup with stateless fails with a configuration error. Ignored over stdio.stateful, declared in src/index.ts
MCP_AUTH_MODEAuth mode: none, jwt, or oauth.none
MCP_REQUEST_STATE_KEYSeals the requestState a confirmation round carries (≥ 32 bytes, the same on every instance, e.g. openssl rand -base64 32); any state the server did not seal is rejected before the handler runs. workflow_delete's round carries its confirmation id, so set it for HTTP deployments.unset
MCP_LOG_LEVELLog level (RFC 5424).info
LOG_TOOL_FAILURE_PAYLOADSLog each failed tool call's arguments and result, redacted by key name and capped at LOG_TOOL_FAILURE_PAYLOAD_MAX_BYTES (default 16384). A secret inside a free-form value is not redacted.false
OTEL_ENABLEDEnable OpenTelemetry instrumentation (spans, metrics, completion logs).false

See .env.example for the full list of optional overrides.


Running the server

Local development

  • Build and run:

    sh
    # One-time buildbun run rebuild
    # Run the built serverbun run start:stdio# orbun run start:http
  • Run checks and tests:

    sh
    bun run devcheck   # Lint, format, typecheck, securitybun run test       # Vitest test suitebun run lint:mcp   # Validate MCP definitions against spec

Docker

sh
docker build -t workflows-mcp-server .docker run --rm \  -v /path/to/workflows-yaml:/workflows-yaml \  -e WORKFLOWS_DIR=/workflows-yaml \  -p 3010:3010 \  workflows-mcp-server

The Dockerfile defaults to HTTP transport, stateful session mode (required — see MCP_SESSION_MODE above), and logs to /var/log/workflows-mcp-server. OpenTelemetry peer dependencies are installed by default — build with --build-arg OTEL_ENABLED=false to omit them.


Project structure

DirectoryPurpose
src/index.tscreateApp() entry point — registers tools and inits the workflow index service.
src/config/Server-specific environment variable parsing and validation with Zod.
src/mcp-server/tools/Tool definitions (*.tool.ts).
src/services/workflow-index/WorkflowIndexService — YAML parsing, index build, watcher, semver lookup, write helpers.
tests/Unit and integration tests mirroring src/.
workflows-yaml/Seed workflow library — categories/ for permanent workflows, temp/ for temporary drafts, global_instructions.md for agent-global guidance.

Development guide

See CLAUDE.md for development guidelines and architectural rules. The short version:

  • Handlers throw, framework catches — no try/catch in tool logic
  • Use ctx.log for request-scoped logging
  • Register new tools via the barrel in src/mcp-server/tools/definitions/index.ts
  • Filesystem operations go through WorkflowIndexService, not directly in tool handlers

Contributing

Issues are welcome. Run checks and tests before submitting:

sh
bun run devcheckbun run test

License

Apache-2.0 — see LICENSE for details.

来源:README.md,提交 148f4db

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

6
  1. v0.5.0最新Oct 29, 2026
  2. v0.4.2Oct 25, 2026
  3. v0.4.1Oct 7, 2026
  4. v0.4.0Sep 24, 2026
  5. v0.3.3Sep 19, 2026
  6. v0.3.2Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分