Bosbase SDK Docs MCP

BosBase SDK文档MCP服务

此MCP（模型上下文协议）服务提供对BosBase JavaScript和Dart SDK文档的访问，允许AI助手了解和参考SDK功能。

注： 这是一个独立的MCP服务。所有文档文件均包含在 mcp/docs/ 目录。

特性

• 资源：将所有SDK文档文件作为MCP资源公开
• 搜索工具：搜索JS和Dart SDK文档
• 获取文档工具：按主题和SDK检索特定文档
• 列表文档工具：列出所有可用的文档资源

安装

来自npm

npm install -g @bosbase/sdk-docs-mcp

安装后，找到包路径：

# Get global npm modules path
npm root -g
# Example output: /usr/local/lib/node_modules

服务地点为： /usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js

来源

看 设置 下面的部分。

配置

光标

Cursor通过其设置原生支持MCP服务器。

步骤：

1. 打开光标设置(Cmd+, 在macOS上， Ctrl+, 在Windows/Linux上）
2. 导航至 特性 → 模型上下文协议
3. 点击 添加服务器 或直接编辑JSON设置

配置（JSON）：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

替代方案（如果本地安装）：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/path/to/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

使用npm脚本：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "npm",
      "args": ["--prefix", "/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp", "start"]
    }
  }
}

重新启动游标 配置后。使用Cursor的AI功能时，MCP服务将可用。

克劳德桌面（克劳德代码）

Claude Desktop为MCP服务器使用配置文件。

配置文件位置：

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• 视窗: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

步骤：

1. 如果配置文件不存在，则创建它
2. 添加MCP服务器配置：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

对于Linux（示例路径）：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/home/user/.npm-global/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

重新启动克劳德桌面 保存配置文件后。

VS代码

VS Code需要MCP扩展才能使用模型上下文协议服务器。

安装：

1. 开放VS代码扩展(Ctrl+Shift+X 或 Cmd+Shift+X)
2. 搜索“模型上下文协议”或“MCP”
3. 安装官方MCP扩展（如果可用）

配置-方法1（设置UI）：

1. 打开VS代码设置(Ctrl+, 或 Cmd+,)
2. 搜索“MCP”
3. 点击“在settings.json中编辑”
4. 添加服务器配置：

{
  "mcp.servers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"],
      "env": {}
    }
  }
}

配置-方法2（工作区设置）： 创建或编辑 .vscode/settings.json 在您的工作空间中：

{
  "mcp.servers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/path/to/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

配置-方法3（用户设置）： 直接编辑用户设置JSON：

• macOS: ~/Library/Application Support/Code/User/settings.json
• 视窗: %APPDATA%\Code\User\settings.json
• Linux: ~/.config/Code/User/settings.json

重新启动VS代码 配置后。

Codeium CodeX

Codeium CodeX支持MCP服务器，以增强AI功能。

步骤：

1. 打开Codeium设置
2. 导航至 AI设置 → MCP服务器 或 集成
3. 点击 添加MCP服务器

配置：

{
  "name": "bosbase-sdk-docs",
  "command": "node",
  "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"],
  "enabled": true
}

或者通过JSON设置：

{
  "codeium.mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

重新启动Codeium 配置后。

崔

Trae支持MCP服务器进行AI交互。

步骤：

1. 打开托盘设置
2. 导航至 MCP配置 或 AI集成
3. 添加新的MCP服务器

配置：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"],
      "description": "BosBase SDK Documentation"
    }
  }
}

配置文件（如果使用基于文件的配置）： 编辑Trae配置文件（位置因平台而异）并添加：

{
  "servers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js"]
    }
  }
}

重新启动Trae 配置后。

授权

MCP服务在本地运行 不需要身份验证或API密钥。所有文件均来自本地文件。

安全说明：

• ✅ 服务作为本地进程运行（stdio传输）
• ✅ 无网络暴露或外部API调用
• ✅ 所有文档文件都是只读的
• ✅ 不需要身份验证令牌或API密钥
• ✅ 完全离线

文件权限： 确保运行MCP客户端的用户具有以下读取权限：

• 编译服务： dist/index.js
• 文档目录： docs/ 以及所有子目录
• Node.js可执行文件

验证： 手动测试服务：

# Test if service can start
node /usr/local/lib/node_modules/@bosbase/sdk-docs-mcp/dist/index.js

如果命令启动时没有错误，则服务已准备就绪。

用法

配置后，MCP服务将在您的AI助手中可用。以下是如何使用它：

在您的AI助手中

问以下问题：

• “如何使用BosBase JS SDK进行身份验证？”

- AI将搜索SDK文档并提供代码示例

• “演示如何在Dart SDK中创建集合”

- AI将检索相关的Dart SDK文档

• “用于文件上载的API方法有哪些？”

- AI将搜索JS和Dart SDK文档

• “比较JS和Dart SDK之间的身份验证方法”

- AI可以从两个SDK访问文档

可用资源

您可以直接访问文档资源：

• sdk-doc://js-collections -JavaScript SDK集合
• sdk-doc://dart-collections -Dart SDK集合
• sdk-doc://js-authentication -JavaScript SDK身份验证
• sdk-doc://dart-authentication -Dart SDK身份验证
• sdk-doc://sdk-overview -SDK主要文档概述

可用工具

该服务提供了人工智能可以使用的三个工具：

1. search_sdk_docs

搜索所有SDK文档。

AI提示示例： “在JS SDK中搜索矢量数据库示例”

2. get_sdk_doc

按主题检索特定文档。

AI提示示例： “获取Dart SDK集合文档”

3. list_sdk_docs

列出所有可用的文档。

AI提示示例： “有哪些SDK文档主题可用？”

故障排除

未找到服务：

• 验证路径 dist/index.js 是正确的
• 检查是否安装了Node.js： node --version
• 确保软件包已安装： npm list -g @bosbase/sdk-docs-mcp

服务未连接：

• 配置后重新启动编辑器/IDE
• 检查服务和文档的文件权限
• 验证路径是否使用绝对路径，而不是相对路径
• 检查编辑器日志中的错误消息

无可用文件：

• 确保 docs/ 目录中存在文档文件
• 检查上的文件权限 docs/ 目录
• 验证文档文件是否 .md 文件

手动测试服务：

# Should start without errors (will wait for stdio input)
node /path/to/@bosbase/sdk-docs-mcp/dist/index.js

可用资源

所有文档文件都作为资源公开，URI如下：

• sdk-doc://js-collections -JavaScript SDK集合文档
• sdk-doc://dart-collections -Dart SDK集合文档
• sdk-doc://sdk-overview -SDK主要文档概述

可用工具

search_sdk_docs

在SDK文档中搜索特定主题、API或代码示例。

参数：

• query （必填）：搜索查询字符串
• sdk （可选）：按SDK类型筛选(js, dart，或 both -默认值： both)
• topic （可选）：按主题筛选（集合、身份验证、文件等）

例子：

{
  "query": "authentication password",
  "sdk": "js",
  "topic": "authentication"
}

get_sdk_doc

检索特定的SDK文档文件。

参数：

• topic （必填）：文档主题（集合、身份验证、文件等）
• sdk （可选）：SDK类型(js 或 dart，除非主题是“概述”，否则为必填项）

例子：

{
  "topic": "collections",
  "sdk": "js"
}

list_sdk_docs

列出所有可用的SDK文档资源。

参数：

• sdk （可选）：按SDK类型筛选(js, dart，或 both -默认值： both)

文档主题

JS和Dart SDK的可用文档主题：

• collections -收集和记录管理
• api-rules -API规则和筛选器语法
• authentication -身份验证方法（密码、OTP、OAuth2、MFA）
• files -文件上传和处理
• file-api -用于下载和缩略图的文件API
• relations -关系字段和扩展功能
• api-records -CRUD操作和记录管理
• realtime -实时订阅和SSE
• collection-api -收款管理API
• logs-api -日志查看和过滤
• crons-api -Cron作业管理
• backups-api -备份操作
• health-api -健康状况检查

从源设置

如果你想从源代码而不是npm安装：

# Clone the repository (or use the mcp directory)
cd mcp

# Install dependencies
npm install

# Copy documentation files (if not already present)
# From the project root:
cp ../js-sdk/docs/*.md docs/js-sdk/
cp ../dart-sdk/docs/*.md docs/dart-sdk/
cp ../SDK_DOCUMENTATION.md docs/

# Build TypeScript
npm run build

# Verify build
ls dist/index.js

然后配置编辑器以使用本地构建：

{
  "mcpServers": {
    "bosbase-sdk-docs": {
      "command": "node",
      "args": ["/absolute/path/to/mcp/dist/index.js"]
    }
  }
}

发展

# Run in development mode (with tsx, no build needed)
npm run dev

# Run built version
npm start

项目结构

mcp/
├── src/
│   └── index.ts          # Main MCP server implementation
├── dist/                 # Compiled JavaScript (generated)
├── docs/                 # SDK documentation files
├── package.json
├── tsconfig.json
└── README.md

许可证

麻省理工学院