项目简介
Nautex AI 编码代理 MCP 服务器是一个后端服务,旨在通过 Model Context Protocol (MCP) 标准,为各类大型语言模型 (LLM) 编码代理(如 Cursor, Claude Code, Codex, OpenCode)提供统一的上下文服务。它将 Nautex AI 平台的项目需求、技术规范、任务计划等信息同步给 LLM 代理,并允许代理通过标准化的工具调用机制更新任务状态和获取下一步指导,从而加速 AI 辅助开发过程。
主要功能点
- 上下文提供: 向 LLM 代理提供详细的产品和技术需求文档、项目文件地图、当前任务列表及其相关文件和说明。
- 任务管理: 支持 LLM 代理获取下一个可执行任务范围('nautex_next_scope'),并更新任务状态('nautex_update_tasks')。
- 文档托管: 自动同步并管理项目相关的文档(如 PRD、TRD)到本地 '.nautex/docs' 目录,供 LLM 代理查阅。
- 代理集成: 提供针对不同编码代理(如 Cursor, Claude Code, Codex, OpenCode)的配置和规则管理,确保其能有效利用 Nautex AI 的指导。
- 状态监控: 提供集成状态检查工具('nautex_status'),帮助用户了解 MCP 服务器与 Nautex AI 平台、以及与 LLM 客户端的连接状况。
安装步骤
- 安装 uv 工具: 'uv' 是一个快速的 Python 包安装器,用于安装 'nautex'。
- 在 macOS 或 Linux 上运行: 'curl -LsSf https://astral.sh/uv/install.sh | sh'
- 在 Windows 上运行: 'powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"'
- 请查看 UV 仓库 获取最新安装说明。
- 初始化项目: 进入你的新项目文件夹,并在终端运行:'uvx nautex setup' 这将启动一个交互式的终端用户界面 (TUI),引导你完成 API 密钥设置、项目选择、计划选择和代理类型配置等步骤。
- 获取 API Token: 访问 Nautex.ai 注册并创建 API Token。
- 在 Nautex.ai 创建 PRD/TRD 和计划: 在 Nautex 网页应用中,与聊天机器人互动以捕获需求、生成文档、创建文件映射,并制定实施计划。
服务器配置(MCP客户端用)
Nautex MCP 服务器的启动命令是 'uvx nautex mcp'。你的 MCP 客户端(如 Cursor、Claude Code 等)需要配置以下信息来连接 Nautex MCP 服务器。具体的配置方式取决于你使用的 MCP 客户端类型。
- Cursor 客户端配置示例 (写入 '.cursor/mcp.json'):
将以下 JSON 配置片段添加到 '.cursor/mcp.json' 文件中,并确保在 Cursor 偏好设置中启用 'nautex' MCP。
{ "mcpServers": { "nautex": { "command": "uvx", // 启动 MCP 服务器的命令 "args": [ "nautex", // 命令的第一个参数 "mcp" // 命令的第二个参数 ], "cwd": "/path/to/your/project" // MCP 服务器运行的当前工作目录(请替换为你的项目根目录的绝对路径) } } } - Claude Code 客户端配置示例 (通过 CLI 命令): 在终端运行以下命令来添加 Nautex MCP: 'claude mcp add nautex -s local -- uvx nautex mcp' 通过运行 'claude mcp list' 验证 'nautex: uvx nautex mcp - ✓ Connected' 条目是否存在。
- Codex 客户端配置示例 (写入 '~/.codex/config.toml'): Nautex 会自动合并/更新此 TOML 文件(通常在首次覆盖前创建备份 'config.toml.bak')。配置中将包含 '[mcp_servers.nautex]' 部分,指定 'command = "uvx"' 和 'args = ["nautex", "mcp"]'。
- OpenCode 客户端配置示例 (写入 'opencode.json'):
Nautex 会自动写入/更新项目根目录下的 'opencode.json' 文件。
{ "$schema": "https://opencode.ai/config.json", "mcp": { "nautex": { "type": "local", // MCP 服务器类型 "command": ["uvx", "nautex", "mcp"], // 启动 MCP 服务器的命令及其参数 "enabled": true // 是否启用该 MCP 服务器 } } }
基本使用方法
- 检查 MCP 服务器响应 (可选): 你可以在终端运行 'uvx nautex mcp test next_scope' 来测试 MCP 服务器是否能正确返回下一个任务范围数据。
- 检查编码代理集成: 确认你的编码代理能够识别并使用 Nautex 工具。例如,在代理的 UI 或命令行中运行 'nautex status' 以获取集成状态。
- 指导编码代理: 在编码代理中输入指令,例如 “Pull nautex rules and proceed to the next scope”(拉取 Nautex 规则并进入下一个任务范围),代理将根据 Nautex AI 提供的任务和指导开始工作。
- 跟进计划: 代理会根据从 Nautex AI 获取的上下文信息进行编码、测试和审查。你需要持续审查代理的进度,并根据需要提供验证反馈和输入。
信息
分类
开发者工具