项目简介
LeanSpec 是一款专为 AI 辅助开发设计的轻量级规范工具。它帮助开发者和 AI 代理以简洁、结构化且易于理解的方式共同维护项目规范 (Specs)。通过将规范保持在 AI 上下文窗口可接受的范围内(通常小于 300 行),LeanSpec 有效解决了传统冗长文档导致 AI "上下文溢出"的问题。它提供命令行 (CLI) 工具和 MCP 服务器功能,使得 AI 代理能够直接获取、创建和更新项目规范,从而提高开发效率和团队协作质量。
主要功能点
- AI 原生集成: 规范采用 MCP (Model Context Protocol) 兼容格式,可与 GitHub Copilot、Claude Code、OpenAI Codex、Cursor 等主流 AI 编码助手无缝协作,为 AI 提供精准的上下文信息。
- 上下文经济: 强制规范保持在 300 行以内,确保 AI 代理能完整加载和理解上下文,避免性能下降。
- 结构化与灵活性: 规范使用带有元数据(如状态、优先级、标签)的 Markdown 格式,既易于人类阅读,又便于 AI 解析和操作。
- 工作流可见性: 通过命令行工具 ('lean-spec board', 'lean-spec stats'),快速查看项目规范的状态看板、统计数据和关键洞察。
- 渐进式结构: 允许团队根据需求逐步增加规范的元数据字段,从简单的状态标签到复杂的企业级字段,适应不同规模的项目。
- 规范生命周期管理: 支持创建、更新和验证规范,确保规范的质量和时效性。
安装步骤
- 安装 Node.js: 确保您的系统已安装 Node.js (推荐 LTS 版本)。
- 安装 LeanSpec CLI: 打开终端,运行以下命令全局安装 LeanSpec CLI 工具:
npm install -g lean-spec - 初始化项目: 进入您的项目目录,运行初始化命令创建 'specs' 目录和配置文件:
cd your-project-directory lean-spec init
服务器配置 (MCP 客户端用)
LeanSpec 可以作为 MCP 服务器运行,通过标准输入/输出 (Stdio) 协议与 MCP 客户端(如 Claude Desktop)通信,为 AI 提供项目规范上下文。以下是 MCP 客户端配置 LeanSpec 服务器的示例信息,您可以在 MCP 客户端的服务器设置中填入:
{ "server name": "LeanSpec CLI Server", "command": "lean-spec", "args": ["mcp-server"], "description": "通过 LeanSpec CLI 访问和管理项目规范,提供 AI 友好的上下文信息。" }
- 'server name': 显示在 MCP 客户端中的服务器名称,例如 "LeanSpec CLI Server"。
- 'command': 启动 LeanSpec CLI 的命令,通常是 'lean-spec'。
- 'args': 传递给 'lean-spec' 命令的参数数组。'mcp-server' 参数指示 LeanSpec 以后台 MCP 服务器模式运行。
- 'description': 对该 MCP 服务器的简要描述。
基本使用方法
- 创建新规范: 让 AI 代理通过调用 'lean-spec create <spec-name>' 创建新的规范 Markdown 文件。例如,AI 可以根据你的指令创建 'user-authentication' 规范。
- 与 AI 协作: 在 Cursor 或其他 AI 助手中使用你的提示词。AI 代理将读取相关的 LeanSpec 规范来理解上下文,并执行编码任务。
- 更新规范状态: 通过 CLI 或 AI 代理更新规范的状态。例如,将规范标记为“进行中”:
lean-spec update <spec-id> --status in-progress - 查看项目看板: 随时在终端查看项目规范的整体状态和进度:
lean-spec board - AI 友好输出: 获取规范的 JSON 格式输出,供 AI 客户端进一步处理:
lean-spec view <spec-id> --json
信息
分类
开发者工具