使用说明

项目简介

Business Central MCP Server (BC-MCP) 是一个应用后端，旨在为使用 Cursor 编辑器进行 Business Central 项目开发的团队提供标准化的开发规则和上下文信息。它通过提供集中的规则管理和分发，帮助团队成员保持代码风格和开发实践的一致性，提高开发效率和代码质量。

主要功能点

静态和动态规则管理: 支持通过 JSON 文件配置静态规则，也支持使用 MongoDB 数据库动态管理和更新规则。
Cursor 编辑器集成: 专门为 Cursor 编辑器优化，通过简单的配置即可将规则应用到开发环境中。
多种部署选项: 提供 Render.com 和 Azure 的快速部署脚本，方便服务器部署和管理。
健康检查端点: 提供 '/health' 端点用于监控服务器运行状态。
规则获取端点: 提供 '/cursorrules' 端点以 JSON 格式获取当前生效的规则集。
SSE 和 WebSocket 支持: 除了 HTTP GET，还支持通过 SSE 和 WebSocket 长连接推送规则更新和进行工具调用 (虽然示例中工具功能较为基础)。

安装步骤

克隆仓库:

git clone https://github.com/vanachterjacob/BC-MCP.git
cd BC-MCP

安装依赖:
```
npm install
```
配置环境变量 (可选):
- 复制 '.env.example' 文件并重命名为 '.env'。
- 根据需要修改 '.env' 文件中的配置，例如 'MCP_SERVER_PORT' (服务器端口) 和 'MONGODB_URI' (MongoDB 连接字符串，如果需要动态规则管理)。
启动服务器:
```
npm start
```
服务器默认运行在 'http://localhost:3000' (或 '.env' 文件中配置的端口)。

服务器配置 (MCP 客户端)

对于 MCP 客户端 (例如 Cursor 编辑器)，需要配置连接到 BC-MCP 服务器的信息。以下是一个 JSON 格式的配置示例，用于 'cursor-connect.js' 文件中或直接在 Cursor 编辑器中配置：

{
  "serverName": "Business Central MCP Server",
  "command": "npm",
  "args": ["start"]
}

配置参数注释:

'serverName': 服务器名称，可以自定义，用于在 MCP 客户端中标识连接。例如: '"Business Central Standards"'。
'command': 启动 MCP 服务器的命令。由于项目使用 'npm start' 启动服务器，因此设置为 '"npm"'。
'args': 'command' 命令的参数。这里设置为 '["start"]'，对应 'npm start' 命令。

基本使用方法

配置 Cursor 编辑器连接:
- 将仓库中的 'cursor-connect.js' 文件复制到你的 Business Central 项目根目录。
- 修改 'cursor-connect.js' 文件中的 'CURSOR_CONFIG.mcpServer' 变量，将其指向你的 BC-MCP 服务器地址 (例如: 'http://localhost:3000' 或部署后的服务器 URL)。
- 在 Cursor 编辑器中，根据 'cursor-connect.js' 文件中的说明，配置连接到 BC-MCP 服务器。通常是将 'cursor-connect.js' 文件引入到 Cursor 的上下文中。
验证连接:
- 启动 BC-MCP 服务器。
- 在 Cursor 编辑器中打开 Business Central 项目文件。
- 检查 Cursor 编辑器是否成功连接到 BC-MCP 服务器并应用了配置的规则。

管理员使用 (规则管理)

静态规则: 直接编辑 'bc-rules.json' 文件来更新静态规则。
动态规则 (如果配置了 MongoDB): 通过直接操作 MongoDB 数据库来管理规则。可以使用 'scripts/generateRules.js' 脚本将数据库中的规则同步到 'bc-rules.json' 文件。
用户和权限管理: BC-MCP 提供用户注册、登录和权限管理功能 (用户角色分为 user, admin, contributor)，可以通过 API 接口进行用户和规则的管理 (具体 API 文档请参考 'src/server.js' 和相关路由文件)。

关键词

使用说明

信息