intent-mcp-server

🚀 意图 MCP 服务器

意图 MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务，它能处理自然语言意图，并将其转化为结构化、可执行的格式。该服务器提供了强大且可靠的 API 来管理和处理意图，在扩展性和可靠性方面表现出色。

🚀 快速开始

意图 MCP 服务器实现了一种意图处理架构，可将自然语言输入转换为结构化对象，并生成可执行的工作流。它注重维护性、类型安全和扩展性，同时提供了简洁的 API 用于意图管理。

先决条件

• Node.js (v18 或更高版本)
• npm 或 yarn

安装

1. 克隆仓库：

git clone https://github.com/openpandacodes/intent-mcp-server.git
cd intent-mcp-server

2. 安装依赖：

npm install

3. 创建一个 .env 文件：

touch .env

配置

可以通过环境变量配置以下选项：

• NODE_ENV：设置环境（默认为 development）
• PORT：设置服务器端口（默认为 3000）
• LOG_LEVEL：设置日志级别（默认为 info）

使用方法

开发模式

npm run dev

生产模式

npm start

测试

npm test

覆盖率测试

npm run coverage

✨ 主要特性

• 🎯 意图处理：创建、获取和处理意图
• 🔍 自然语言理解：解析并理解用户的原始意图
• 🧩 意图分解：将意图转化为结构化对象，包含目标和约束
• 💾 灵活存储：可插拔的存储系统，内置内存实现
• 📝 类型安全：完整的 TypeScript 实现，附带全面的类型定义
• 🛡️ 错误处理：强大的错误处理和日志记录系统
• 🧪 测试：全面的测试套件使用 Jest
• 📚 API 文档：清晰的 API 文档和示例

💻 使用示例

基础用法

以下是使用 API 端点的示例：

创建意图

POST /intents

获取意图

GET /intents/:id

健康检查

GET /health

📚 详细文档

API 端点

创建意图

POST /intents

获取意图

GET /intents/:id

健康检查

GET /health

架构

该服务器遵循分层架构：

• 控制器（Controller）：处理 HTTP 请求和响应。
• 服务（Service）：负责业务逻辑和数据操作。
• 存储（Storage）：提供数据持久化功能。

关键组件

• IntentController：处理意图相关请求。
• IntentService：管理意图的创建和检索。
• IntentStore：存储意图数据。

项目结构

intent-mcp-server/
├── src/
│   ├── controllers/
│   │   └── IntentController.ts
│   ├── services/
│   │   └── IntentService.ts
│   └── storage/
│       └── IntentStore.ts
├── .env
└── package.json

意图结构

interface Intent {
  id: string;
  name: string;
  description?: string;
  status: 'pending' | 'processing' | 'completed' | 'failed';
  metadata?: Record<string, any>;
}

错误处理

• 提供自定义错误类。
• 记录日志以跟踪问题。
• 返回适当的 HTTP 状态码。

🔧 技术细节

该项目注重维护性、类型安全和扩展性，使用完整的 TypeScript 实现，附带全面的类型定义。它采用分层架构，将不同的功能模块分离，提高了代码的可维护性和可扩展性。同时，项目提供了强大的错误处理和日志记录系统，确保在出现问题时能够及时发现和解决。

🤝 贡献指南

1. 创建功能分支：

git checkout -b feature/new-feature

2. 提交代码时遵循 Conventional Commits 规范。

3. 提交 Pull Request 到主要仓库。

4. 更新相关文档和测试用例。

📄 许可证

MIT License - 详情请参阅 LICENSE 文件