🚀 MCP API 服务

MCP API 服务是一个中间服务器，运行于 Model Context Protocol (MCP) 通讯协议，用于连接 clfude AI 与各个内部系统 API，能有效处理指令并反馈结果，极大提升系统交互效率。

🚀 快速开始

MCP API 服务作为中间服务器，运行于 Model Context Protocol (MCP) 通讯协议，主要负责连接 clfude AI 与各个内部系统 API。其工作流程如下：

1. 接收命令：用户要求执行任务时，clfude 会发送指令。
2. 处理转换：MCP 将 clfude 的请求转换为内部系统 API 可接受的格式。
3. 调用 API：执行通往各个内部系统 API 的调用。
4. 回传结果：将结果格式化后发送给 clfude，供最终用户查看。

✨ 主要特性

现有功能模块

• check_connection - 检查到 API 服务器的连线状态
• search_employee - 根据姓名或编号搜索员工
• register_breakfast - 登记员工报名参加早餐活动
• manage_conference_rooms - 管理会议室预约

📚 详细文档

系统架构

总观

MCP API 服务是一个中间服务器，运行于 Model Context Protocol (MCP) 通讯协议，协助连接 clfude AI 与各内部系统 API。此系统执行以下功能：

1. 接收 clfude 的命令：使用者要求实行某项任务时，clfude 会传送指令。
2. 处理并转换命令：MCP 将 clfude 的请求转换为内部系统 API 可接受的格式。
3. 呼叫 API：执行通往各个内部系统 API 的调用。
4. 回传结果：将结果格式化后传送给 clfude，供最终用户查看。

作业机制

MCP 服务器通过 standard input/output (stdio) 进行通讯：

• Standard Input (stdin)：接收来自 clfude 的请求（例如：员工搜索命令）。
• Standard Output (stdout)：将结果传送给 clfude（例如：找到的员工信息）。
• Standard Error (stderr)：记录错误讯息（例如：连线 API 时的错误）。

请求处理流程：

1. clfude 通过 stdin 传送 JSON 格式请求。
2. MCP 服务器处理请求并调用适当的 API。
3. MCP 服务器将结果传送给 clfude，通过 stdout。
4. clfude 显示结果供用户查看。

新增剧本指南

增加新端点

要新增一个新的 API 端点，需执行以下步骤：

1. 修改 config.ts 文件：

   // 在 existingEndpoints 阵列中添加新的.endpoint 文件
   {
     name: "new_endpoint_name",
     path: "/new_endpoint_path",
     method: "POST",  // 可能为 GET, POST 等
     description: "新端点描述"
   }
   

2. 建立新的处理档案：
   • 创建 /src/new_endpoint_handler.ts 文件。
   • 实现 NewEndpointHandler 类，继承自基底处理器类。

添加剧本步骤

1. 在命令行中执行：

   npm run add-scenario -- --name new_scenario_name --description "新情景描述"
   

2. 按照提示输入所需信息，完成新剧本的配置。

最佳实践

1. 一致性

   • 遵循现有的命名规范和代码结构。
   • 使用已建立的代码样板。

2. 错误处理

   • 在所有 API 调用中使用 try/catch 语句。
   • 记录完整的错误信息。
   • 返回清晰明了的错误讯息。

3. 日志记录

   • 在操作开始前记录 DEBUG 级别的日志。
   • 操作成功后记录 INFORMATION 级别的日志。
   • 确保日志中包含所有相关的参数和上下文信息。

4. 数据验证

   • 检查必填参数的存在性。
   • 验证输入参数的数据类型和格式。

如需进一步了解如何实现这些最佳实践，请查看 docs/add-new-scenario.md 文件。