article
README
🚀 工作流 MCP 服务器
这是一个用 Python 开发的结构化工作流引导代理的 MCP 服务器。此服务器可确保代理按照预定义步骤执行任务,同时还能保持执行过程的灵活性。
🚀 快速开始
此部分将为你介绍项目的开发方法、安装步骤、使用方法、工作流定义、可用工具以及许可证信息。
✨ 主要特性
- 借助 Python 开发,实现结构化工作流引导。
- 利用 UV 进行高效包管理,保障执行的灵活性。
- 支持通过 SSE 进行通信。
📦 安装指南
设置环境
# 创建虚拟环境
uv venv
# 激活虚拟环境
source .venv/bin/activate # Linux/macOS
# 或者
.venv\Scripts\activate # Windows
# 安装包
uv pip install -e .
# 开发环境(带测试工具)
uv pip install -e ".[dev]"
💻 使用示例
基础用法
运行服务器
# 使用入口脚本
uv run workflow-mcp
# 或者直接使用模块
uv run python -m workflow_mcp_server
运行测试
uv run pytest
高级用法
使用 SSE 而不是 stdio:
uv run workflow-mcp --sse --port 8888
📚 详细文档
工作流定义
在 frameworks 目录中创建 YAML 文件,结构如下:
name: "Simple Workflow"
description: "A linear workflow with basic steps"
version: "1.0"
steps:
- id: "step1"
type: "instruction"
content: "这是你需要首先完成的事情"
next: "step2"
- id: "step2"
type: "tool_call"
tool: "工具名称"
parameters:
param1: "值1"
next: "step3"
- id: "step3"
type: "end"
content: "工作流完成"
可用工具
list_workflows(): 列出可用的工作流框架start_workflow(workflow_id): 启动新的工作流会话complete_step(session_id, result): 标记当前步骤为完成并获取下一个步骤
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group