SWIC-故事工作流集成控制器
](https://www.npmjs.com/package/@kelceyp/swic) 
SWIC(故事工作流集成控制器)是一个MCP(模型上下文协议)服务器,用于通过结构化工作流管理故事、子任务和管道。它为Claude提供了CLI和MCP工具来编排开发工作流。
特性
- 故事管理:将工作组织成具有规格、设计和子任务的结构化故事
- MCP集成:通过模型上下文协议与Claude代码进行本地集成
- CLI工具:用于直接操作的命令行界面
- 文档管理:带命名空间的项目和共享文档存储
- 工作流程编排:故事创建、设计和实施的自动化工作流程
安装
使用npm
npm install -g @kelceyp/swic使用包子
bun add -g @kelceyp/swic作为项目依赖
# npm
npm install --save-dev @kelceyp/swic
# bun
bun add -D @kelceyp/swic快速开始
CLI使用情况
# Create a doc in project scope
swic doc create project quickstart "# Quick Start\n\nGetting started with SWIC"
# List all docs
swic doc list
# Read a doc
swic doc read project quickstart
# Edit a doc
swic doc edit project quickstart --replace-once "Quick Start" "Getting Started"
# Delete a doc
swic doc delete project quickstartMCP与Claude的集成
添加到您的 .mcp.json 或Claude桌面配置:
{
"mcpServers": {
"swic": {
"command": "swic-mcp"
}
}
}配置后,Claude可以访问SWIC工具:
User: Create a project doc called "architecture" with our system design
Claude: *uses swic doc_create tool*目录结构
SWIC在首次使用时创建两个数据目录:
.swic/-项目特定数据(在项目根中创建)
- docs/ -项目文件 - stories/ -故事工作流程
~/.swic/-共享数据(在主目录中创建)
- docs/ -跨所有项目共享文档 - templates/ -可重复使用的模板 - workflows/ -工作流定义
这些目录是在您首次使用SWIC时自动创建的。
可用的MCP工具
当用作MCP服务器时,SWIC为Claude提供以下工具:
doc_create-创建新文档doc_read-阅读一个或多个文档doc_edit-编辑文档内容doc_delete-删除一个或多个文档doc_list-列出所有文件doc_move-移动或重命名文档
CLI命令
文档管理
# Create
swic doc create
[content]
# Read
swic doc read
# Edit
swic doc edit --replace-once "old" "new"
swic doc edit --replace-all "old" "new"
swic doc edit --replace-all-content "new content"
# Delete
swic doc delete
# List
swic doc list [scope]
# Move
swic doc move 范围: project 或 shared
发展
从源头构建
# Clone the repository
git clone https://github.com/kelceyp/swic.git
cd swic
# Install dependencies
bun install
# Build distribution
bun run build
# Test locally
./dist/cli/cli.js doc list运行测试
# Run E2E tests locally
bun run test:e2e:local
# Run E2E tests in Docker
bun run test:e2e项目理念
SWIC遵循以下核心原则:
- 不要帮忙 -只做要求的事,不镀金
- 对范围要残忍 -没有额外功能,没有“当我在做的时候”
- 遵循故事过程 -规范定义什么,设计定义如何
- 室温铁磁性 -实施前的研究
- 没有向后兼容性 -突破性的改变是可以的
- 无倒退或违约 -快速失败,不要掩盖问题
- 测量两次,切割一次 -向左移动,提问,做设计
- 不要跑在用户前面 -与用户合作
- 无时间估算 -他们总是错的,只管去做
看 CLAUDE.md 获取完整的开发指南。
许可证
麻省理工学院
作者
保罗·凯尔西
仓库
问题
报告问题:
