项目简介
TimeWarp.Nuru.Mcp 是一个专为 TimeWarp.Nuru CLI 框架设计的 Model Context Protocol (MCP) 服务器。它旨在通过支持 MCP 协议的 AI 助手(如 Claude Code, Roo Code, Continue)提供智能开发支持,帮助开发者更高效地构建命令行应用程序。它本身不是一个独立的 CLI 框架,而是为 TimeWarp.Nuru 框架提供 AI 辅助功能的后端服务。
主要功能点
- 路由模式验证: 实时检查 TimeWarp.Nuru 路由模式的语法和语义错误,确保其符合规范。
- 代码生成: 根据提供的路由模式自动生成 C# 处理器代码,支持直接委托(Delegate)和 Mediator 模式,简化开发流程。
- 语法文档查询: 提供 TimeWarp.Nuru 路由模式的详细语法文档和使用示例,方便开发者学习和参考。
- 错误处理信息: 提供关于 TimeWarp.Nuru 中错误处理机制、错误类型以及最佳实践的文档,帮助开发者更好地处理应用中的异常。
- 缓存管理: 允许清除和查看 MCP 服务器内部用于存储文档和示例的缓存状态,确保获取最新信息。
- 版本信息: 查询 TimeWarp.Nuru.Mcp 服务器的当前版本信息。
安装步骤
- 安装 .NET SDK: 确保您的开发环境已安装最新版本的 .NET SDK。
- 打开命令行终端: 在您的操作系统中打开命令提示符或 PowerShell/Bash 终端。
- 全局安装 MCP 服务器工具: 运行以下命令全局安装 TimeWarp.Nuru.Mcp 工具:
dotnet tool install --global TimeWarp.Nuru.Mcp - 验证安装 (可选): 运行 'dotnet tool run TimeWarp.Nuru.Mcp -- --help',如果看到帮助信息,则表示安装成功。
服务器配置
MCP 客户端需要配置服务器的启动命令和参数才能与此服务器建立连接。以下是一个配置此 MCP 服务器的 JSON 格式示例:
{ "server_name": "TimeWarp Nuru MCP Server", "command": "dotnet", "args": ["tool", "run", "TimeWarp.Nuru.Mcp"] }
- 'server_name': 给 MCP 服务器取一个易于识别的名称,方便在客户端中查找和管理。
- 'command': 启动 MCP 服务器的执行程序。对于通过 'dotnet tool install --global' 命令全局安装的 .NET 工具,此值通常是 '"dotnet"'。
- 'args': 传递给 'command' 的参数列表。'["tool", "run", "TimeWarp.Nuru.Mcp"]' 指示 .NET 工具运行时来启动已安装的 'TimeWarp.Nuru.Mcp' 工具。
基本使用方法
安装并配置好您选择的 MCP 客户端(例如支持 MCP 协议的 AI 代码编辑器扩展或独立的 AI 助手应用)后,您可以:
- 验证路由模式: 在 AI 助手中请求验证一个 TimeWarp.Nuru 路由模式,例如,您可以输入指令:"Validate this Nuru route pattern: 'deploy {env} --version {tag}'",服务器将返回详细的验证结果。
- 生成处理器代码: 要求 AI 助手根据路由模式生成 C# 代码,例如:"Generate a C# handler for 'backup {source} {dest?}' using mediator pattern",服务器将生成相应的代码片段。
- 查询语法文档: 询问 AI 助手关于 Nuru 路由模式的语法细节,例如:"Get syntax documentation for Nuru parameters",服务器将提供详细的解释和示例。
- 获取错误处理指南: 查询 TimeWarp.Nuru 框架的错误处理最佳实践,例如:"Get best practices for error handling in TimeWarp.Nuru"。
AI 助手将通过与 TimeWarp.Nuru.Mcp 服务器的交互,为您提供即时、准确的帮助和代码生成,极大提升开发效率。
信息
分类
开发者工具