用 MCP Prompts 构建 AI 驱动的项目文档管理工具:SoloFlow MCP

背景与动机

在软件开发过程中,项目文档管理一直是一个痛点。传统的文档管理方式存在以下问题:

  1. 文档分散:需求文档、架构设计、任务列表等散落在不同位置
  2. 格式不统一:团队成员使用不同的文档格式和模板
  3. 更新滞后:文档更新跟不上代码变更
  4. AI 协作困难:AI 助手难以理解项目的整体结构和上下文

随着 Cursor 1.3 的发布,引入了 MCP Prompts 功能,这为 AI 驱动的项目文档管理提供了新的可能性。

什么是 MCP?

Model Context Protocol (MCP) 是一个开放协议,允许 AI 助手通过标准化的接口与外部工具和服务进行交互。MCP 的核心优势包括:

  • 标准化接口:统一的工具调用方式
  • 安全性:路径隔离和权限控制
  • 可扩展性:支持自定义工具和服务
  • IDE 集成:与 Cursor 等现代 IDE 无缝集成

Cursor 1.3 的 MCP Prompts 功能

Cursor 1.3 引入了 MCP Prompts 功能,这是一个重要的创新:

功能特点

  • 自定义提示词:开发者可以定义自己的 AI 提示词
  • 上下文感知:提示词可以访问项目特定的上下文信息
  • 自动化执行:AI 可以直接执行预定义的提示词
  • 标准化格式:统一的提示词定义和调用方式

使用场景

  • 项目初始化
  • 代码审查
  • 文档生成
  • 任务管理
  • 部署检查

MCP Prompts vs 传统方式:为什么效果更好?

传统方式的局限性

1. Cursor Rules 的局限

markdown 复制代码
# 传统 .cursor/rules 方式
---
description: 项目文档管理规则
alwaysApply: true
---

- 手动编写规则
- 静态的指导原则
- 缺乏动态交互
- 难以维护和更新

问题:

  • 静态性:规则一旦编写就很难动态调整
  • 缺乏上下文:无法根据项目状态智能调整
  • 维护困难:需要手动更新规则文件
  • 交互性差:无法与 AI 进行实时交互

2. 用户自编提示词的痛点

bash 复制代码
# 传统方式:用户需要自己编写复杂的提示词
"请帮我创建一个项目文档结构,包括需求文档、架构设计、任务列表等,格式要统一,内容要完整..."

问题:

  • 重复性工作:每次都要重新编写提示词
  • 质量不稳定:不同用户编写的提示词质量差异很大
  • 缺乏标准化:没有统一的格式和规范
  • 效率低下:需要大量时间调试和优化提示词

MCP Prompts 的革命性改进

1. 标准化和可复用性

typescript 复制代码
// MCP Prompts 方式:预定义的标准化提示词
export const prompts = [
  {
    name: "init-project",
    description: "Initialize project documentation structure",
    inputSchema: {
      type: "object",
      properties: {
        projectName: { type: "string" }
      }
    }
  }
];

优势:

  • 标准化:统一的提示词格式和调用方式
  • 可复用:一次定义,多处使用
  • 版本控制:可以像代码一样进行版本管理
  • 团队协作:团队成员可以共享和复用提示词

2. 动态上下文感知

typescript 复制代码
// MCP Prompts 可以访问项目上下文
export async function initProject(args: { projectName?: string }) {
  const projectRoot = getCurrentProjectRoot();
  const existingDocs = await listDocuments(projectRoot);
  
  // 根据现有文档智能调整初始化策略
  if (existingDocs.length > 0) {
    return "Project already has documentation. Would you like to update existing docs?";
  }
  
  return createProjectStructure(projectRoot, args.projectName);
}

优势:

  • 智能感知:根据项目状态动态调整行为
  • 上下文理解:可以访问项目的实际文件和结构
  • 个性化:根据项目类型和需求提供定制化服务
  • 实时反馈:可以实时响应用户的操作和项目变化

3. 集成化的工作流

bash 复制代码
# 传统方式:分散的操作
1. 手动创建文档目录
2. 编写提示词请求 AI 生成内容
3. 手动复制粘贴 AI 回复
4. 手动保存文件
5. 重复上述步骤...

# MCP Prompts 方式:一键完成
/soloflow-mcp/init-project

优势:

  • 一键操作:复杂的多步骤操作简化为一个命令
  • 自动化:减少人工干预,提高效率
  • 一致性:确保每次操作的结果都符合预期
  • 可追溯:操作过程可以被记录和审计

实际效果对比

传统方式的效果

erlang 复制代码
用户:请帮我创建项目文档
AI:好的,我来帮你创建项目文档。首先,我们需要...
用户:等等,我需要什么格式的文档?
AI:您希望使用什么格式?
用户:Markdown 格式
AI:好的,我来创建 Markdown 格式的文档...
用户:我需要包含哪些文档类型?
AI:通常包括需求文档、架构设计、任务列表等...
用户:具体内容怎么写?
AI:这取决于您的项目需求...

问题: 需要大量来回对话,效率低下

MCP Prompts 的效果

diff 复制代码
用户:/soloflow-mcp/init-project
AI:✅ 项目文档结构已创建完成!
- 已创建 8 个核心文档
- 已设置标准模板
- 已配置 Git 提交规范
- 已生成项目概览

接下来您可以:
- 使用 /soloflow-mcp/add-task 添加任务
- 使用 /soloflow-mcp/check-project-status 检查状态

优势: 一键完成,结果标准化,可预期

SoloFlow MCP 项目介绍

基于 MCP 协议和 Cursor 1.3 的 MCP Prompts 功能,我开发了 SoloFlow MCP,一个专门用于项目文档管理的 MCP 服务器。

核心功能

1. 四种核心操作

typescript 复制代码
// 列出所有文档
list(projectRoot: string): Document[]

// 读取文档内容
read(projectRoot: string, type: DocType): string

// 更新文档内容
update(projectRoot: string, type: DocType, content: string): void

// 初始化项目
init(projectRoot: string): void

2. 六种内置提示词

bash 复制代码
/soloflow-mcp/init-project          # 初始化项目文档结构
/soloflow-mcp/create-doc-template   # 创建标准文档模板
/soloflow-mcp/add-task             # 添加新任务
/soloflow-mcp/check-project-status # 检查项目状态
/soloflow-mcp/code-review-checklist # 获取代码审查清单
/soloflow-mcp/deployment-checklist  # 获取部署准备清单

3. 八种文档类型

  • overview.md - 项目概览
  • requirements.md - 功能需求
  • system_architecture.md - 系统架构
  • test_strategy.md - 测试策略
  • tasks.md - 任务列表
  • ui_design.md - UI 设计
  • deployment.md - 部署配置
  • notes.md - 项目笔记

技术架构

项目结构

csharp 复制代码
src/
├── index.ts              # 服务入口
├── context.ts            # 项目上下文管理
├── tools/                # MCP 操作实现
│   ├── list.ts
│   ├── read.ts
│   ├── update.ts
│   └── init.ts
├── prompts/              # MCP Prompts 实现
│   └── index.ts
├── types/
│   └── docTypes.ts       # 文档类型定义
└── resources/
    ├── soloflow-content.ts
    └── git-commit-content.ts

安全设计

  • 路径隔离 :基于 projectRoot 的访问控制
  • 类型验证:预定义文档类型白名单
  • 内容验证:防止空内容提交
  • 错误处理:完善的错误码和提示

安装和使用

1. 安装配置

在项目根目录创建 .cursor/mcp.json

json 复制代码
{
  "mcpServers": {
    "soloflow-mcp": {
      "command": "npx",
      "args": ["@benyue1978/soloflow-mcp"]
    }
  }
}

或配置到Cursor全局的MCP列表中:

3. 使用提示词

在 Cursor 聊天框中输入:

bash 复制代码
/soloflow-mcp/init-project

AI 将自动创建完整的项目文档结构。

实际应用场景

场景一:新项目启动

  1. 运行初始化命令
  2. 使用 /soloflow-mcp/init-project 创建文档结构
  3. 使用 /soloflow-mcp/add-task 添加任务

场景二:代码审查

  1. 使用 /soloflow-mcp/code-review-checklist 获取审查清单
  2. AI 根据项目上下文生成针对性的审查建议
  3. 自动更新相关文档

场景三:部署准备

  1. 使用 /soloflow-mcp/deployment-checklist 获取部署清单
  2. 检查项目文档完整性
  3. 验证部署配置

技术亮点

1. MCP Prompts 实现

typescript 复制代码
// prompts/index.ts
export const prompts = [
  {
    name: "init-project",
    description: "Initialize project documentation structure",
    inputSchema: {
      type: "object",
      properties: {
        projectName: { type: "string" }
      }
    }
  }
  // ... 其他提示词
];

2. 文档类型系统

typescript 复制代码
// types/docTypes.ts
export enum DocType {
  OVERVIEW = "overview",
  REQUIREMENTS = "requirements",
  SYSTEM_ARCHITECTURE = "system_architecture",
  TEST_STRATEGY = "test_strategy",
  TASKS = "tasks",
  UI_DESIGN = "ui_design",
  DEPLOYMENT = "deployment",
  NOTES = "notes"
}

版本发布

目前项目已发布到 NPM:

  • 包名@benyue1978/soloflow-mcp
  • 最新版本:v1.0.5
  • 下载量:持续增长
  • GitHub Stars:欢迎关注

实际案例对比

案例:创建项目文档

传统方式(耗时 15-20 分钟):

  1. 用户编写详细提示词
  2. AI 生成内容
  3. 用户检查和完善
  4. 手动创建文件
  5. 复制粘贴内容
  6. 重复上述步骤...

MCP Prompts 方式(耗时 30 秒):

  1. 用户输入 /soloflow-mcp/init-project
  2. 系统自动完成所有操作
  3. 用户获得完整的项目文档结构

未来规划

短期目标

  • 支持更多文档格式(JSON、YAML)
  • 增加更多内置提示词

长期愿景

  • 构建完整的 AI 驱动开发工作流
  • 支持更多 IDE 和编辑器

总结

MCP Prompts 相比传统方式的主要优势:

  1. 效率提升:从分钟级操作降低到秒级
  2. 质量保证:标准化的输出,减少人为错误
  3. 可维护性:集中管理,易于更新和维护
  4. 团队协作:统一的工具和流程
  5. 可扩展性:易于添加新功能和定制化需求
  6. 安全性:更好的权限控制和路径隔离

SoloFlow MCP 项目展示了如何利用 Cursor 1.3 的 MCP Prompts 功能构建实用的 AI 驱动工具。通过标准化的文档管理和智能提示词,我们可以在保持开发效率的同时,确保项目文档的完整性和一致性。

这种改进不仅提升了开发效率,更重要的是为 AI 辅助开发建立了标准化的基础设施,为未来的发展奠定了坚实的基础。

相关链接

欢迎关注项目,提出建议!

相关推荐
人生都在赌4 小时前
MCP最佳实践与性能优化:构建高效稳定的AI工具连接器
ai编程·cursor·mcp
寅时码1 天前
消除大模型幻觉,让AI-IDE真正理解代码,打通LSP与AI的任督二脉
visual studio code·cursor·mcp
SugarPPig1 天前
使用的IDE没有内置MCP客户端怎么办?
ide·mcp
ffutop1 天前
MCP 能力探索
mcp
带刺的坐椅2 天前
Solon v3.4.2(Java 应用开发生态基座)
java·ai·solon·liteflow·mcp
青衫客362 天前
LLM—— 基于 MCP 协议(Stdio 模式)的工具调用实践
大模型·llm·mcp
友莘居士2 天前
本地使用postman调试mcp接口
测试工具·postman·sse·mcp
摘星编程3 天前
MCP提示词工程:上下文注入的艺术与科学
人工智能·提示词工程·a/b测试·mcp·上下文注入
思绪漂移3 天前
阿里云 【免费试用】MCP 赋能可视化 OLAP 智能体应用
阿里云·云计算·agent·云原生数据库·mcp