序列图生成服务

一个与Swimlanes.io集成的模型上下文协议(MCP)服务器,用于从文本描述生成序列图,支持AI助手(如GitHub Copilot)自动分析项目代码库并创建全面的图表文档。

  • by joelong01
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 joelong01/sl_mcp

使用说明

Swimlanes.io MCP 服务器

一种模型上下文协议(MCP)服务器,与Swimlanes.io集成,根据文本描述生成序列图。该服务器使GitHub Copilot等AI助手能够自动分析项目代码库并创建全面的图表文档。

特性

  • Markdown文档生成:创建包含嵌入式图表的完整markdown文件
  • 版本控制就绪:存储源语法和渲染图像以进行git跟踪
  • 多种输出格式:支持直接图像生成和可共享链接
  • 项目分析:专为Copilot设计,用于分析代码库并生成相关图表
  • 组织结构:自动将图表组织到逻辑文件夹结构中

安装

npm install
npm run build

用法

使用克劳德桌面

添加到您的Claude Desktop配置中:

{
  "mcpServers": {
    "swimlanes": {
      "command": "node",
      "args": ["path/to/dist/index.js"]
    }
  }
}

配备MCP检查员(用于测试)

npx @modelcontextprotocol/inspector node dist/index.js

工具

1. create_swimlane_documentation

生成带有嵌入式图表的完整markdown文档。

参数:

  • text (字符串,必填):泳道语法内容
  • title (字符串,必填):图表标题
  • description (字符串,可选):图表描述
  • outputPath (string,可选):保存markdown文件的位置
  • includeImage (布尔值,可选):是否嵌入渲染图像(默认值:true)
  • folderStructure (字符串,可选):文件夹组织(例如“auth”、“api”)

2. generate_swimlane_image

生成并保存泳道图的PNG图像。

参数:

  • text (字符串,必填):泳道语法内容
  • title (字符串,可选):可选标题
  • highResolution (布尔值,可选):用于打印质量(默认值:false)
  • outputPath (字符串,可选):保存图像的位置

3. get_swimlane_image_link

无需下载即可生成指向PNG图像的直接链接。

参数:

  • text (字符串,必填):泳道语法内容
  • title (字符串,可选):可选标题
  • highResolution (布尔值,可选):用于打印质量(默认值:false)

Swimlanes.io语法

服务器支持完整的Swimlanes.io语法:

title: Example Diagram
A -> B: Message
B -> A: Response
note over A: Internal process

有关完整的语法参考,请参阅: https://swimlanes.io/gallery/full-syntax

Copilot使用示例

询问副驾驶:“使用SL_MCP服务器,为这个项目构建泳道图”

Copilot将分析您的代码库,并为以下内容生成适当的图表:

  • 身份验证流程
  • API请求生命周期
  • 服务通信
  • 用户旅程
  • 数据处理管道

发展

# Install dependencies
npm install

# Build the project
npm run build

# Watch mode for development
npm run dev

# Run tests
npm run test

# Lint code
npm run lint

项目结构

src/
├── index.ts           # Main MCP server entry point
├── types.ts           # TypeScript type definitions
└── tools/
    ├── index.ts       # Tool exports
    └── swimlane-tools.ts  # Core tool implementations

生成的文档结构

服务器创建组织良好的文档:

docs/diagrams/
├── auth/
│   ├── login-flow.md
│   └── images/
│       └── login-flow.png
├── api/
│   ├── request-lifecycle.md
│   └── images/
│       └── request-lifecycle.png
└── architecture/
    ├── service-communication.md
    └── images/
        └── service-communication.png

许可证

麻省理工学院