当前的RMS MCP服务器
](https://www.npmjs.com/package/@nospi/current-rms-mcp) 
一个用于与Current RMS(租赁管理系统API)集成的模型上下文协议(MCP)服务器。该服务器使Claude等AI助手能够与您的Current RMS数据进行交互,管理库存、商机和客户信息。
🚀 快速入门
使用这个MCP服务器的最快方法是通过npx:
npx @nospi/current-rms-mcp您需要为认证设置环境变量(请参阅下面的配置部分)。
📋 先决条件
- Node.js 18 或更高版本
- 一个具有API访问权限的当前RMS账户
- API凭据(子域和API密钥)
获取当前RMS API凭据
- 登录到您的当前RMS账户
- 导航至 系统设置 > 集成 > API
- 生成一个新的API密钥
- 记下您的子域名(例如,如果您的网址是
mycompany.current-rms.com,您的子域名是mycompany)
📦 安装
方法1:使用npx(推荐)
无需安装!只需运行:
CURRENT_SUBDOMAIN=your-subdomain CURRENT_API_KEY=your-api-key npx @nospi/current-rms-mcp方法2:全局安装
npm install -g @nospi/current-rms-mcp然后运行:
current-rms-mcp方法3:从源代码开始
# Clone the repository
git clone https://github.com/nospi/current-rms-mcp.git
cd current-rms-mcp
# Install dependencies
npm install
# Build the project
npm run build
# Run the server
npm start🔧 配置
环境变量
创建一个 .env 在项目根目录中创建文件(或设置环境变量):
CURRENT_SUBDOMAIN=your-subdomain
CURRENT_API_KEY=your-api-keyClaude 桌面集成
将此配置添加到您的Claude桌面设置中:
对于npx的使用:
{
"mcpServers": {
"current-rms": {
"command": "npx",
"args": ["@nospi/current-rms-mcp"],
"env": {
"CURRENT_SUBDOMAIN": "your-subdomain",
"CURRENT_API_KEY": "your-api-key"
}
}
}
}对于全球安装:
{
"mcpServers": {
"current-rms": {
"command": "current-rms-mcp",
"env": {
"CURRENT_SUBDOMAIN": "your-subdomain",
"CURRENT_API_KEY": "your-api-key"
}
}
}
}对于本地开发:
{
"mcpServers": {
"current-rms": {
"command": "node",
"args": ["/absolute/path/to/current-rms-mcp/dist/index.js"],
"env": {
"CURRENT_SUBDOMAIN": "your-subdomain",
"CURRENT_API_KEY": "your-api-key"
}
}
}
}🛠️ 可用工具
产品管理
list_products
搜索并列出您库存中的产品。
// Example: List products with pagination
{
"page": 1,
"per_page": 20,
"q": {
"product_group_id_eq": 5,
"tag_names_contains": "audio"
}
}get_product
获取特定产品的详细信息。
// Example: Get product by ID
{
"id": 123
}机会管理
list_opportunities
列出租赁机会(报价/订单)。
// Example: List confirmed opportunities in date range
{
"page": 1,
"per_page": 10,
"q": {
"state_eq": 3, // 3 = Confirmed
"starts_at_gteq": "2024-01-01T00:00:00Z",
"ends_at_lteq": "2024-12-31T23:59:59Z"
}
}国家价值观:
- 0:开启
- 1: 暂定的
- 2: 保留
- 3: 已确认
- 5:已取消
- 6: 结束
- 7: 失去(或“迷失”)
get_opportunity
获取特定机会的详细信息。
{
"id": 456
}可用性
check_availability
检查特定日期范围内产品的可用性。
// Example: Check if product is available for rental
{
"product_id": 123,
"starts_at": "2024-03-15T09:00:00Z",
"ends_at": "2024-03-20T17:00:00Z",
"store_id": 1
}客户管理
list_members
列出成员(客户/联系人)。
// Example: Search for active customers by name
{
"page": 1,
"per_page": 20,
"q": {
"name_cont": "Smith",
"active_eq": true
}
}get_member
获取特定成员的详细信息。
{
"id": 789
}🧪 开发
在开发模式下运行
npm run dev建筑
npm run build测试
测试服务器连接:
node test-server.js📝 使用 Claude 的示例
一旦配置好,您可以要求Claude:
- “列出下周所有可用的音频设备”
- “检查佳能5D Mark IV在3月15日至20日期间是否有货”
- “给我显示这个月所有已确认的订单”
- “查找客户约翰·史密斯的联系方式”
- “列出库存中带有‘照明’标签的产品”
🤝 贡献
欢迎贡献!请随时提交拉取请求。
- 为仓库创建分支(或“克隆仓库”)
- 创建你的特性分支(
git checkout -b feature/AmazingFeature) - 提交您的更改(
git commit -m 'Add some AmazingFeature') - 推送到分支(
git push origin feature/AmazingFeature) - 提交一个拉取请求
🐛 故障排除
常见问题
认证失败
- 验证您的子域和API密钥是否正确
- 检查您的API密钥是否具有必要的权限
- 确保环境变量已正确设置
连接错误
- 检查您的网络连接
- 验证当前RMS API是否可访问
- 检查是否有任何防火墙限制
速率限制
- 当前的RMS有API速率限制
- 如有需要,在请求之间实施适当的延迟
- 如果您需要更高的限值,请联系电流有效值(RMS)支持团队
📄 许可证
这个项目遵循MIT许可证授权——详见 许可证 详情请查阅文件。
🔗 链接
💬 支持
对于问题和疑问:
- 在(某个平台/项目)上打开一个议题/问题
- 检查一下 当前的RMS API文档
- 请联系当前的RMS支持团队,针对API相关问题进行咨询
______________________________________________________________________
由nospi用心打造❤️
