Comedy MCP Server

Comedy MCP 服务

一个模型上下文协议（MCP）服务实现，为 AI 助手提供与喜剧相关的工具和服务。此服务与 Cursor IDE 集成，并通过 MCP 工具提供各种喜剧相关功能。

概述

Comedy MCP 服务使用 ASP.NET Core 构建，并实现模型上下文协议（MCP），为 AI 助手提供生成编程笑话和幽默代码注释的工具。它充当 AI 模型与喜剧相关功能之间的桥梁。

功能

• 编程笑话：生成随机的编程相关笑话
• 代码注释：根据代码上下文和主题创建幽默的注释
• 回显服务：展示日志记录功能的演示服务
• Swagger 集成：API 文档和测试界面
• 运行状况检查端点：基本的服务状态监控

架构

服务由以下组件构成：

• MCP 服务集成：使用 ModelContextProtocol.Server 实现 MCP
• 喜剧服务：实现 IComedyService，用于生成笑话和注释
• HTTP 通信：使用 stdio 与 Cursor IDE 通信
• 日志记录：提供可配置级别的全面日志记录
• CORS 支持：针对 MCP 检查器工具进行配置

工具

该服务提供以下 MCP 工具：

1. GetProgrammingJoke

   • 描述：获取一则随机的编程相关笑话
   • 参数：无
   • 返回：包含笑话的字符串

2. GetCodeComment

   • 描述：生成与特定代码上下文相关的幽默注释
   • 参数：
     • codeContext：代码片段或上下文
     • topic：注释的主题
   • 返回：与代码相关的幽默注释

3. EchoWithLog

   • 描述：通过日志记录回显消息的演示工具
   • 参数：
     • message：要回显的消息
   • 返回：回显的消息

安装和配置

先决条件

• .NET 8.0 SDK 或更高版本
• Node.js 14+（用于 MCP 检查器工具）
• 代码编辑器（为获得最佳集成体验，建议使用 Cursor IDE）
• Git（用于版本控制）

安装步骤

1. 克隆代码库：

git clone [your-repository-url]
cd ComedyMcpServer

2. 配置环境：

   • 复制示例环境文件：

     copy .env.example .env    # On Windows
     # OR
     cp .env.example .env     # On Unix-based systems
     

   • 如有需要，使用你的设置更新 .env 文件

3. 安装依赖项：

dotnet restore

4. 构建项目：

dotnet build

运行服务

你可以通过以下几种方式运行服务：

1. 开发模式：

dotnet run --environment Development

2. 使用 MCP 检查器（建议用于调试 MCP 工具）：

npx @modelcontextprotocol/inspector dotnet run

3. 生产模式：

dotnet run --environment Production

验证安装

1. 检查服务是否正在运行：

   • 在浏览器中打开 http://localhost:5000 或配置的端口
   • 你应该会看到消息“Comedy MCP Server is running!”

2. 访问 Swagger 文档：

   • 前往 http://localhost:5000/swagger
   • 你应该会看到 API 文档

3. 测试 MCP 工具：

   • 使用随附的测试脚本：

     node test-mcp.js
     

   • 如果使用检查器运行，也可以使用 MCP 检查器界面

故障排除

常见问题及解决方案：

1. 端口已被占用：

   • 在 appsettings.json 中更改端口
   • 或停止占用当前端口的进程

2. 缺少依赖项：

   • 再次运行 dotnet restore
   • 检查你的 .NET SDK 版本是否符合项目要求

3. 环境变量未加载：

   • 确保 .env 文件存在且格式正确
   • 修改环境文件后重启应用程序

如需排查更详细的问题，请查看控制台输出中的应用程序日志。

开发

该项目遵循标准的 ASP.NET Core 实践，并包含 MCP 专用组件：

• 在 DI 容器中注册服务
• 自动从程序集发现工具
• 为开发和调试配置日志记录
• 提供 Swagger 作为 API 文档

部署

该项目包含：

• Procfile：用于平台部署
• nixpacks.toml：构建配置
• 标准的 ASP.NET Core 部署选项

测试

项目包含一个测试脚本（test-mcp.js），用于验证 MCP 功能。

健康检查

访问根端点（/）以验证服务状态：

GET / -> "Comedy MCP Server is running!"

API 文档

运行时，可通过以下地址访问 Swagger UI：

/swagger

贡献

欢迎通过以下方式参与贡献：

1. 实现新的喜剧相关工具
2. 增强现有的笑话生成
3. 改进错误处理和日志记录
4. 添加新的喜剧服务

许可证

[在此填写许可证信息]