sx-platform-mcp 0.0.0-stage → 0.0.2

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/.env.example ADDED
@@ -0,0 +1,33 @@
1
+ # ---------------------------------------------------------------------------
2
+ # sx-mcp 部署配置(可选)
3
+ #
4
+ # 同机部署默认零配置即可:平台地址默认 http://127.0.0.1:8000(同机 nginx 的
5
+ # /api 出口),服务监听 127.0.0.1:8790。身份(令牌 + 租户)由调用方按请求头
6
+ # sx-token / sx-tenant-id 带来,进程不持有任何凭据。
7
+ #
8
+ # 需要覆盖时:把本文件复制一份,改名为 .env,改完双击 start.bat 生效。
9
+ # .env 是纯文本,不要提交到任何仓库,也不要往里面写令牌。
10
+ # ---------------------------------------------------------------------------
11
+
12
+ # 平台地址:MCP 与 nginx 不在同一台机器时,改成平台 / nginx 的地址
13
+ SX_BASE_URL=http://127.0.0.1:8000
14
+ #
15
+ # 外部连接器(WorkBuddy auth_mode=token)会按请求带这几个头,覆盖上面的默认值:
16
+ # sx-base-url 客户自己的平台地址(每个客户不同)
17
+ # sx-tenant-id 租户编码
18
+ # sx-account / sx-password 账号密码,服务端换取令牌后按人缓存(不落盘)
19
+ # sx-password-mode md5(默认)| plain | auto
20
+ # 头名可改:SX_BASE_URL_HEADER / SX_ACCOUNT_HEADER / SX_PASSWORD_HEADER /
21
+ # SX_PASSWORD_MODE_HEADER
22
+
23
+ # 监听端口:8790 被占用时改这里(服务只监听 127.0.0.1)
24
+ # SX_MCP_HTTP_PORT=8790
25
+
26
+ # 其它可选配置(一般不用动):
27
+ # SX_TENANT_ID=000000 兜底租户,调用方没带 sx-tenant-id 时使用
28
+ # SX_TOOL_GROUPS=all 只注册指定分组,逗号分隔;all 表示不限制
29
+ # SX_TOOL_GROUPS_EXCLUDE= 屏蔽指定分组(优先级高于白名单)
30
+ # SX_ALLOW_WRITES=true 是否允许写操作
31
+ # SX_DEBUG=1 打开调试日志(每次工具调用打印接口与耗时)
32
+ # SX_TIMEOUT_MS=30000 单次调用平台接口的超时(毫秒)
33
+ # SX_TLS_INSECURE=false 仅内网自签证书时设为 true
package/README.md CHANGED
@@ -1,3 +1,44 @@
1
- # Temporary Holding Version
1
+ # sx-platform-mcp
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ 思绪云平台(Sixu Cloud)的 **MCP 服务**,stdio 形态,供 WorkBuddy / Claude Desktop / Cursor 等
4
+ 支持 MCP 的客户端通过 npx 拉起。
5
+
6
+ ## 用法(WorkBuddy 自定义连接器 / 手动测试)
7
+
8
+ 用户只需在连接器表单里填写四项:**服务器地址、租户、账号、密码**。
9
+ 客户端会把它们注入环境变量,进程启动时自动登录:
10
+
11
+ ```bash
12
+ npx -y sx-platform-mcp
13
+ ```
14
+
15
+ | 环境变量 | 必填 | 说明 |
16
+ | --- | --- | --- |
17
+ | `SX_BASE_URL` | 是 | 平台地址,例如 `http://127.0.0.1:8000` 或 `https://mes.example.com:9443` |
18
+ | `SX_TENANT_ID` | 是 | 租户编码(与平台登录页一致),例如 `MES` / `PROJ` |
19
+ | `SX_ACCOUNT` | 是 | 登录账号 |
20
+ | `SX_PASSWORD` | 是 | 登录密码(也支持 `SX_PASSWORD_FILE` 指向文件) |
21
+ | `SX_PASSWORD_MODE` | 否 | `md5`(默认)/ `plain` / `auto` |
22
+ | `SX_TOKEN` | 否 | 直接给令牌时优先使用(跳过账号密码登录) |
23
+ | `SX_ALLOW_WRITES` | 否 | `true`(默认)允许写操作,`false` 只读 |
24
+ | `SX_TOOL_GROUPS` / `SX_TOOL_GROUPS_EXCLUDE` | 否 | 工具分组白名单 / 黑名单,`all` 表示不限制 |
25
+ | `SX_TIMEOUT_MS` | 否 | 单次平台调用超时,默认 30000 |
26
+
27
+ ## 本地调试
28
+
29
+ ```bash
30
+ SX_BASE_URL=http://127.0.0.1:8000 SX_TENANT_ID=MES SX_ACCOUNT=admin SX_PASSWORD=your-password \
31
+ npx -y sx-platform-mcp
32
+ ```
33
+
34
+ `--list-tools` 可以只打印注册的工具清单(不启动 MCP):
35
+
36
+ ```bash
37
+ npx -y sx-platform-mcp --list-tools | head
38
+ ```
39
+
40
+ ## 说明
41
+
42
+ - 凭据只在进程内存里用于换令牌,不落盘;
43
+ - 日志走 stderr,只打印账号 / 租户 / 令牌指纹,**不打印密码与原始令牌**;
44
+ - 需要 Node.js **22.18+**。