localsbnb-mcp-server 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -5
- package/dist/package.json +1 -1
- package/mcp.sample.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## 这是什么？
|
|
4
4
|
|
|
5
|
-
路客云 AI 助手让您可以在 **Cursor**、**Claude Desktop** 等 AI 工具中，直接用自然语言操作路客云 SPMS（酒店物业管理系统）。
|
|
5
|
+
路客云 AI 助手让您可以在 **Cursor**、**Claude Desktop**、**Claude Code** 等 AI 工具中，直接用自然语言操作路客云 SPMS（酒店物业管理系统）。
|
|
6
6
|
|
|
7
7
|
例如，您可以说：
|
|
8
8
|
|
|
@@ -42,13 +42,13 @@ AI 会帮您调用路客云，并返回结果。
|
|
|
42
42
|
| **Node.js** | ≥ 18.0（运行 `node -v` 检查） |
|
|
43
43
|
| **路客云账号** | 已开通路客云 SPMS |
|
|
44
44
|
| **访问凭证** | 已获取 **APP_SECRET** 与 **APP_ID**（由路客云管理员配置） |
|
|
45
|
-
| **AI 客户端** | 已安装 Cursor 或 Claude
|
|
45
|
+
| **AI 客户端** | 已安装 Cursor、Claude Desktop 或 Claude Code |
|
|
46
46
|
|
|
47
47
|
### 二、获取访问凭证
|
|
48
48
|
|
|
49
49
|
| 凭证 | 说明 | 示例格式 |
|
|
50
50
|
|------|------|----------|
|
|
51
|
-
| **APP_SECRET** | 路客云访问令牌，用于 API 鉴权 |
|
|
51
|
+
| **APP_SECRET** | 路客云访问令牌，用于 API 鉴权 | 由路客云后台提供的 token 字符串 |
|
|
52
52
|
| **APP_ID** | 营地/物业 ID，标识一家店或经营主体 | 数字字符串，如 `12345` |
|
|
53
53
|
|
|
54
54
|
请联系路客云管理员或进入路客云后台获取：https://minsubao.localhome.cn/ → 「设置」→「API 密钥管理」或联系技术支持。
|
|
@@ -78,7 +78,7 @@ AI 会帮您调用路客云，并返回结果。
|
|
|
78
78
|
"command": "npx",
|
|
79
79
|
"args": ["--yes", "localsbnb-mcp-server"],
|
|
80
80
|
"env": {
|
|
81
|
-
"APP_SECRET": "
|
|
81
|
+
"APP_SECRET": "<你的 token>",
|
|
82
82
|
"APP_ID": "<你的 campId>"
|
|
83
83
|
}
|
|
84
84
|
}
|
|
@@ -94,7 +94,7 @@ AI 会帮您调用路客云，并返回结果。
|
|
|
94
94
|
"command": "sh",
|
|
95
95
|
"args": ["/你的实际路径/dist/run.sh"],
|
|
96
96
|
"env": {
|
|
97
|
-
"APP_SECRET": "
|
|
97
|
+
"APP_SECRET": "<你的 token>",
|
|
98
98
|
"APP_ID": "<你的 campId>"
|
|
99
99
|
}
|
|
100
100
|
}
|
|
@@ -115,10 +115,52 @@ AI 会帮您调用路客云，并返回结果。
|
|
|
115
115
|
2. 添加与上文相同的 `mcpServers` 配置块
|
|
116
116
|
3. 保存并重启 Claude Desktop
|
|
117
117
|
|
|
118
|
+
#### 配置 Claude Code
|
|
119
|
+
|
|
120
|
+
Claude Code 是终端版 Claude，通过 `claude mcp add` 添加 MCP 服务。包已发布到 npm，可直接用 npx 运行：
|
|
121
|
+
|
|
122
|
+
**方式 1：命令行添加（推荐）**
|
|
123
|
+
|
|
124
|
+
在终端执行（**替换凭证为你的实际值**）。注意：**服务器名必须写在 `-e` 参数之前**：
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
claude mcp add LocalsBnbMCP --scope user \
|
|
128
|
+
-e APP_SECRET="<你的 token>" \
|
|
129
|
+
-e APP_ID="<你的 campId>" \
|
|
130
|
+
-- npx -y localsbnb-mcp-server
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
- 使用 `-e KEY=value` 传递环境变量（勿用 `--env`）
|
|
134
|
+
- `--scope user`：所有项目可用；改为 `--scope local` 仅当前项目
|
|
135
|
+
|
|
136
|
+
**方式 2：手动编辑配置文件**
|
|
137
|
+
|
|
138
|
+
在项目根目录创建或编辑 `.mcp.json`：
|
|
139
|
+
|
|
140
|
+
```json
|
|
141
|
+
{
|
|
142
|
+
"mcpServers": {
|
|
143
|
+
"LocalsBnb MCP": {
|
|
144
|
+
"command": "npx",
|
|
145
|
+
"args": ["-y", "localsbnb-mcp-server"],
|
|
146
|
+
"env": {
|
|
147
|
+
"APP_SECRET": "<你的 token>",
|
|
148
|
+
"APP_ID": "<你的 campId>"
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
也可将 MCP 配置写入用户级 `~/.claude.json` 的 `mcpServers` 字段。
|
|
156
|
+
|
|
157
|
+
**验证**：在 Claude Code 中输入 `/mcp` 查看是否已加载，或直接说「查询今天的房态」测试。
|
|
158
|
+
|
|
118
159
|
### 五、验证配置
|
|
119
160
|
|
|
120
161
|
- **Cursor**：`Cmd/Ctrl + Shift + P` → 输入「MCP」，查看是否出现 `LocalsBnb MCP` 相关工具
|
|
121
162
|
- **Claude Desktop**：新开对话，输入 `@LocalsBnb MCP` 或「查询今天的房态」
|
|
163
|
+
- **Claude Code**：输入 `/mcp` 查看工具，或直接说「查询今天的房态」
|
|
122
164
|
|
|
123
165
|
若能返回房态、订单等数据，说明配置成功。
|
|
124
166
|
|
package/dist/package.json
CHANGED
package/mcp.sample.json
CHANGED