MCP NLX Node.js Server

MCP NLX Node.js 服务

项目描述

此项目是使用 NLX 框架实现的 Model Context Protocol（MCP）Node.js 服务。它提供了一个可处理工具请求并通过 API 调用与 NLX 应用通信的服务。

配置

Claude Desktop

1. 打开 Claude Desktop 配置：

   open ~/Library/Application\ Support/Claude/claude_desktop_config.json
   

2. 添加 NLX 应用配置：

   {
     "mcpServers": {
       "nlx": {
         "command": "npx",
         "args": ["-y", "@nlxai/mcp-nodejs-server"],
         "env": {
           "NLX_API_KEY": "",
           "NLX_APP_URL": ""
         }
       }
     }
   }
   

设置

前置条件

• Node.js（版本 18 或更高）
• npm（Node 包管理器）

安装

1. 克隆仓库：

   git clone <repository-url>
   

2. 导航到项目目录：

   cd nlx-mcp-server
   

3. 安装依赖项：

   npm install
   

用法

环境变量

• NLX_APP_URL：NLX 应用的基础 URL。
• NLX_API_KEY：用于向 NLX 应用发送经过身份验证的请求的 API 密钥。

运行服务

要启动服务，请运行以下命令：

npm run start

服务将启动并通过标准输入/输出监听请求。

故障排除

常见问题

• 找不到模块错误：确保所有依赖项均已正确安装，且导入语句中的路径正确。
• 环境变量：确保在环境中正确设置了 NLX_APP_URL 和 NLX_API_KEY。

Linter 错误

• 找不到模块：检查模块路径是否正确，以及模块是否已安装。
• 隐式的 'any' 类型：考虑添加 TypeScript 类型定义，以避免隐式的 'any' 类型。

发布管理

使用 Semantic Release 自动发布

此项目使用 semantic-release 自动完成版本管理和发布流程。Semantic Release 会根据提交消息自动更新版本号和变更日志。

提交消息格式

Semantic Release 使用 Angular 提交消息规范。以下是格式简介：

• feat：新增功能
• fix：修复错误
• docs：仅修改文档
• style：不影响代码含义的修改（空白字符、格式、缺少分号等）
• refactor：既不修复错误也不新增功能的代码更改
• perf：提升性能的代码更改
• test：补充缺失的测试或修正现有测试
• chore：修改构建流程或文档生成等辅助工具和库

如何发布

要创建新版本，只需将更改推送到 main 分支。CI/CD 流水线会自动运行 semantic-release，以确定下一个版本号、更新变更日志并发布版本。

请确保提交消息遵循 Angular 规范，以触发正确的版本更新。

在 CI/CD 出现紧急情况时，你可以运行以下命令手动触发发布：

npx semantic-release --no-ci