@yyaylt/zhipu-web-search-mcp-server 1.0.7 → 1.0.8
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 +0 -10
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +0 -13
- package/dist/server.js.map +1 -1
- package/package.json +1 -1
- package/src/server.ts +0 -19
- package/dist/serverGuide.d.ts +0 -3
- package/dist/serverGuide.d.ts.map +0 -1
- package/dist/serverGuide.js +0 -53
- package/dist/serverGuide.js.map +0 -1
- package/src/serverGuide.ts +0 -54
package/README.md
CHANGED
|
@@ -44,16 +44,6 @@ codex mcp add zhipu-web-search --env ZHIPU_API_KEY=your_api_key_here -- npx -y @
|
|
|
44
44
|
|
|
45
45
|
Windows 下若客户端无法直接执行 `npx`,可将启动命令改为 `cmd /c npx -y @yyaylt/zhipu-web-search-mcp-server`。添加后重启 Codex,即可在会话中调用 `zhipu_web_search` 工具。
|
|
46
46
|
|
|
47
|
-
### MCP 资源
|
|
48
|
-
|
|
49
|
-
服务器暴露一个静态 Markdown 资源,Codex 等 MCP 客户端可通过 `list_mcp_resources` 发现、通过 `read_mcp_resource` 按需读取:
|
|
50
|
-
|
|
51
|
-
| URI | MIME 类型 | 内容 |
|
|
52
|
-
| --- | --- | --- |
|
|
53
|
-
| `zhipu://web-search/usage-guide` | `text/markdown` | 工具用途、调用时机、参数约束、已知边界、运行前提、隐私与错误码 |
|
|
54
|
-
|
|
55
|
-
资源内容由服务器静态生成,不读取环境变量值,也不会携带 `ZHIPU_API_KEY` 等运行期敏感信息。客户端只有在需要时读取该资源,不会随每次会话自动注入上下文。
|
|
56
|
-
|
|
57
47
|
## 配置
|
|
58
48
|
|
|
59
49
|
通过环境变量 `ZHIPU_API_KEY` 提供 API Key:
|
package/dist/server.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAWpE,wBAAgB,YAAY,IAAI,SAAS,CAmHxC"}
|
package/dist/server.js
CHANGED
|
@@ -13,7 +13,6 @@ import { callWebSearch, handleApiError } from "./services/webSearchApi.js";
|
|
|
13
13
|
import { WebSearchInputSchema, WebSearchRequestSchema } from "./schemas/webSearch.js";
|
|
14
14
|
import { CHARACTER_LIMIT } from "./constants.js";
|
|
15
15
|
import { formatResultsMarkdown } from "./formatResultsMarkdown.js";
|
|
16
|
-
import { buildServerGuideMarkdown, SERVER_GUIDE_RESOURCE_URI } from "./serverGuide.js";
|
|
17
16
|
import { readFileSync } from "node:fs";
|
|
18
17
|
// 发布包与源码均从根 package.json 读取同一版本来源。
|
|
19
18
|
const packageInfo = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
|
|
@@ -22,18 +21,6 @@ export function createServer() {
|
|
|
22
21
|
name: "zhipu-web-search-mcp-server",
|
|
23
22
|
version: packageInfo.version
|
|
24
23
|
});
|
|
25
|
-
// 注册静态使用指南资源;SDK 自动挂载 resources/list 与 resources/read,
|
|
26
|
-
// 供 Codex 等客户端发现并按需读取,不携带运行期密钥等敏感信息。
|
|
27
|
-
server.registerResource("zhipu-web-search-usage-guide", SERVER_GUIDE_RESOURCE_URI, {
|
|
28
|
-
description: "智谱 Web Search MCP Server 使用指南:工具用途、参数约束、已知边界、运行前提与错误码。",
|
|
29
|
-
mimeType: "text/markdown"
|
|
30
|
-
}, async () => ({
|
|
31
|
-
contents: [{
|
|
32
|
-
uri: SERVER_GUIDE_RESOURCE_URI,
|
|
33
|
-
mimeType: "text/markdown",
|
|
34
|
-
text: buildServerGuideMarkdown(packageInfo.version)
|
|
35
|
-
}]
|
|
36
|
-
}));
|
|
37
24
|
// 注册网络搜索工具
|
|
38
25
|
server.registerTool("zhipu_web_search", {
|
|
39
26
|
title: "智谱网络搜索",
|
package/dist/server.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGvC,mCAAmC;AACnC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAwB,CAAC;AAEzH,MAAM,UAAU,YAAY;IAC1B,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,IAAI,EAAE,6BAA6B;QACnC,OAAO,EAAE,WAAW,CAAC,OAAO;KAC7B,CAAC,CAAC;IAEH,WAAW;IACX,MAAM,CAAC,YAAY,CACjB,kBAAkB,EAClB;QACE,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;+BA0BY;QACzB,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,IAAI;SACpB;KACF,EACD,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;QACtB,MAAM,OAAO,GAAG,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;aAC1G,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,qGAAqG;qBAC5G;iBACF;aACF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAErE,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;YACzC,MAAM,MAAM,GAAwB;gBAClC,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;gBACvC,KAAK,EAAE,OAAO,CAAC,MAAM;gBACrB,OAAO;aACR,CAAC;YAEF,MAAM,KAAK,GAAa,EAAE,CAAC;YAC3B,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrC,KAAK,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,WAAW,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;YACrE,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAChH,KAAK,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YACvD,CAAC;YACD,8BAA8B;YAC9B,MAAM,cAAc,GAAG,eAAe,OAAO,CAAC,MAAM,sCAAsC,CAAC;YAC3F,MAAM,QAAQ,GAAG,CAAC,QAAQ,GAAG,CAAC,GAAG,KAAK,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;YAC7E,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC;YACnG,IAAI,SAAS,EAAE,CAAC;gBACd,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC7B,CAAC;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAE7E,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACrD,iBAAiB,EAAE,MAAM;aAC1B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC;qBAC5B;iBACF;aACF,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/package.json
CHANGED
package/src/server.ts
CHANGED
|
@@ -14,7 +14,6 @@ import { callWebSearch, handleApiError } from "./services/webSearchApi.js";
|
|
|
14
14
|
import { WebSearchInputSchema, WebSearchRequestSchema } from "./schemas/webSearch.js";
|
|
15
15
|
import { CHARACTER_LIMIT } from "./constants.js";
|
|
16
16
|
import { formatResultsMarkdown } from "./formatResultsMarkdown.js";
|
|
17
|
-
import { buildServerGuideMarkdown, SERVER_GUIDE_RESOURCE_URI } from "./serverGuide.js";
|
|
18
17
|
import { readFileSync } from "node:fs";
|
|
19
18
|
import type { WebSearchToolOutput } from "./types.js";
|
|
20
19
|
|
|
@@ -27,24 +26,6 @@ export function createServer(): McpServer {
|
|
|
27
26
|
version: packageInfo.version
|
|
28
27
|
});
|
|
29
28
|
|
|
30
|
-
// 注册静态使用指南资源;SDK 自动挂载 resources/list 与 resources/read,
|
|
31
|
-
// 供 Codex 等客户端发现并按需读取,不携带运行期密钥等敏感信息。
|
|
32
|
-
server.registerResource(
|
|
33
|
-
"zhipu-web-search-usage-guide",
|
|
34
|
-
SERVER_GUIDE_RESOURCE_URI,
|
|
35
|
-
{
|
|
36
|
-
description: "智谱 Web Search MCP Server 使用指南:工具用途、参数约束、已知边界、运行前提与错误码。",
|
|
37
|
-
mimeType: "text/markdown"
|
|
38
|
-
},
|
|
39
|
-
async () => ({
|
|
40
|
-
contents: [{
|
|
41
|
-
uri: SERVER_GUIDE_RESOURCE_URI,
|
|
42
|
-
mimeType: "text/markdown",
|
|
43
|
-
text: buildServerGuideMarkdown(packageInfo.version)
|
|
44
|
-
}]
|
|
45
|
-
})
|
|
46
|
-
);
|
|
47
|
-
|
|
48
29
|
// 注册网络搜索工具
|
|
49
30
|
server.registerTool(
|
|
50
31
|
"zhipu_web_search",
|
package/dist/serverGuide.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"serverGuide.d.ts","sourceRoot":"","sources":["../src/serverGuide.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,mCAAmC,CAAC;AAE1E,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CA8ChE"}
|
package/dist/serverGuide.js
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
// SPDX-License-Identifier: MIT
|
|
2
|
-
// 对外暴露的服务器使用指南资源:供 Codex 等 MCP 客户端通过 resources/list 发现、
|
|
3
|
-
// resources/read 读取,作为调用搜索工具前的静态上下文。
|
|
4
|
-
// 固定资源 URI,客户端可据此缓存或订阅;变更需同步 README 与资源测试。
|
|
5
|
-
export const SERVER_GUIDE_RESOURCE_URI = "zhipu://web-search/usage-guide";
|
|
6
|
-
export function buildServerGuideMarkdown(version) {
|
|
7
|
-
return `# 智谱 Web Search MCP Server 使用指南
|
|
8
|
-
|
|
9
|
-
- 服务器名称:zhipu-web-search-mcp-server
|
|
10
|
-
- 版本:${version}
|
|
11
|
-
- 用途:基于智谱开放平台 Web Search API 提供实时网络搜索,返回网页标题、摘要、链接、来源等信息。
|
|
12
|
-
|
|
13
|
-
## 可用工具
|
|
14
|
-
|
|
15
|
-
服务器只注册一个工具:\`zhipu_web_search\`。需要实时网页信息、新闻、公开资料或对搜索结果做后续处理时再调用它;它不能替代问答知识、代码执行或本地文件访问。
|
|
16
|
-
|
|
17
|
-
### 何时调用
|
|
18
|
-
|
|
19
|
-
- 用户问题依赖当前时间、最新事件或联网资料,且本地/模型知识不足时。
|
|
20
|
-
- 需要核对公开网页内容、获取来源链接或做事实检索时。
|
|
21
|
-
- 不要在搜索词中携带个人敏感信息,也不要将 \`user_id\` 用作真实身份标识。
|
|
22
|
-
|
|
23
|
-
### 核心参数
|
|
24
|
-
|
|
25
|
-
| 参数 | 约束 |
|
|
26
|
-
| --- | --- |
|
|
27
|
-
| \`search_query\` | 必填;建议不超过 70 个字符 |
|
|
28
|
-
| \`search_engine\` | \`search_std\`(默认)/ \`search_pro\` / \`search_pro_sogou\` / \`search_pro_quark\` |
|
|
29
|
-
| \`search_intent\` | 布尔值,默认 \`false\`;开启后返回搜索意图识别 |
|
|
30
|
-
| \`count\` | 默认 10;基础版/高阶版 1-50;搜狗仅 10/20/30/40/50;夸克不支持,不能指定 |
|
|
31
|
-
| \`search_domain_filter\` | 白名单域名;夸克不支持,不能指定 |
|
|
32
|
-
| \`search_recency_filter\` | \`oneDay\` / \`oneWeek\` / \`oneMonth\` / \`oneYear\` / \`noLimit\`(默认,发送请求时省略) |
|
|
33
|
-
| \`content_size\` | \`medium\`(默认)/ \`high\` |
|
|
34
|
-
| \`user_id\` | 可选;终端用户匿名标识,长度 6-128 字符 |
|
|
35
|
-
|
|
36
|
-
### 已知边界
|
|
37
|
-
|
|
38
|
-
- 同时指定域名过滤和时间过滤时,官网注明 \`count\` 不生效,请以实际返回条数为准。
|
|
39
|
-
- 输出为 Markdown 文本(最多 100,000 字符,超长按完整条目截断),并附带完整结构化 JSON。
|
|
40
|
-
- 智谱 API 不可用或响应异常时工具返回 \`isError\`;请根据错误信息提示用户重试或调整查询,不要伪造结果。
|
|
41
|
-
|
|
42
|
-
## 运行前提
|
|
43
|
-
|
|
44
|
-
- 启动前必须通过环境变量提供 \`ZHIPU_API_KEY\`;缺失时服务器直接退出,调用工具时也会返回缺少密钥的提示。
|
|
45
|
-
- API Key 只属于运行环境,不要要求用户在对话中提供,也不要将其写入资源、日志或仓库。
|
|
46
|
-
|
|
47
|
-
## 隐私与错误码
|
|
48
|
-
|
|
49
|
-
- 搜索内容会发送至智谱开放平台;\`user_id\` 请只传匿名化标识。
|
|
50
|
-
- 常见错误码:1701 并发超限(稍后重试)、1702 无可用搜索服务、1703 未返回有效数据(调整查询)。
|
|
51
|
-
`;
|
|
52
|
-
}
|
|
53
|
-
//# sourceMappingURL=serverGuide.js.map
|
package/dist/serverGuide.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"serverGuide.js","sourceRoot":"","sources":["../src/serverGuide.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,wDAAwD;AACxD,qCAAqC;AAErC,2CAA2C;AAC3C,MAAM,CAAC,MAAM,yBAAyB,GAAG,gCAAgC,CAAC;AAE1E,MAAM,UAAU,wBAAwB,CAAC,OAAe;IACtD,OAAO;;;OAGF,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCb,CAAC;AACF,CAAC"}
|
package/src/serverGuide.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
// SPDX-License-Identifier: MIT
|
|
2
|
-
// 对外暴露的服务器使用指南资源:供 Codex 等 MCP 客户端通过 resources/list 发现、
|
|
3
|
-
// resources/read 读取,作为调用搜索工具前的静态上下文。
|
|
4
|
-
|
|
5
|
-
// 固定资源 URI,客户端可据此缓存或订阅;变更需同步 README 与资源测试。
|
|
6
|
-
export const SERVER_GUIDE_RESOURCE_URI = "zhipu://web-search/usage-guide";
|
|
7
|
-
|
|
8
|
-
export function buildServerGuideMarkdown(version: string): string {
|
|
9
|
-
return `# 智谱 Web Search MCP Server 使用指南
|
|
10
|
-
|
|
11
|
-
- 服务器名称:zhipu-web-search-mcp-server
|
|
12
|
-
- 版本:${version}
|
|
13
|
-
- 用途:基于智谱开放平台 Web Search API 提供实时网络搜索,返回网页标题、摘要、链接、来源等信息。
|
|
14
|
-
|
|
15
|
-
## 可用工具
|
|
16
|
-
|
|
17
|
-
服务器只注册一个工具:\`zhipu_web_search\`。需要实时网页信息、新闻、公开资料或对搜索结果做后续处理时再调用它;它不能替代问答知识、代码执行或本地文件访问。
|
|
18
|
-
|
|
19
|
-
### 何时调用
|
|
20
|
-
|
|
21
|
-
- 用户问题依赖当前时间、最新事件或联网资料,且本地/模型知识不足时。
|
|
22
|
-
- 需要核对公开网页内容、获取来源链接或做事实检索时。
|
|
23
|
-
- 不要在搜索词中携带个人敏感信息,也不要将 \`user_id\` 用作真实身份标识。
|
|
24
|
-
|
|
25
|
-
### 核心参数
|
|
26
|
-
|
|
27
|
-
| 参数 | 约束 |
|
|
28
|
-
| --- | --- |
|
|
29
|
-
| \`search_query\` | 必填;建议不超过 70 个字符 |
|
|
30
|
-
| \`search_engine\` | \`search_std\`(默认)/ \`search_pro\` / \`search_pro_sogou\` / \`search_pro_quark\` |
|
|
31
|
-
| \`search_intent\` | 布尔值,默认 \`false\`;开启后返回搜索意图识别 |
|
|
32
|
-
| \`count\` | 默认 10;基础版/高阶版 1-50;搜狗仅 10/20/30/40/50;夸克不支持,不能指定 |
|
|
33
|
-
| \`search_domain_filter\` | 白名单域名;夸克不支持,不能指定 |
|
|
34
|
-
| \`search_recency_filter\` | \`oneDay\` / \`oneWeek\` / \`oneMonth\` / \`oneYear\` / \`noLimit\`(默认,发送请求时省略) |
|
|
35
|
-
| \`content_size\` | \`medium\`(默认)/ \`high\` |
|
|
36
|
-
| \`user_id\` | 可选;终端用户匿名标识,长度 6-128 字符 |
|
|
37
|
-
|
|
38
|
-
### 已知边界
|
|
39
|
-
|
|
40
|
-
- 同时指定域名过滤和时间过滤时,官网注明 \`count\` 不生效,请以实际返回条数为准。
|
|
41
|
-
- 输出为 Markdown 文本(最多 100,000 字符,超长按完整条目截断),并附带完整结构化 JSON。
|
|
42
|
-
- 智谱 API 不可用或响应异常时工具返回 \`isError\`;请根据错误信息提示用户重试或调整查询,不要伪造结果。
|
|
43
|
-
|
|
44
|
-
## 运行前提
|
|
45
|
-
|
|
46
|
-
- 启动前必须通过环境变量提供 \`ZHIPU_API_KEY\`;缺失时服务器直接退出,调用工具时也会返回缺少密钥的提示。
|
|
47
|
-
- API Key 只属于运行环境,不要要求用户在对话中提供,也不要将其写入资源、日志或仓库。
|
|
48
|
-
|
|
49
|
-
## 隐私与错误码
|
|
50
|
-
|
|
51
|
-
- 搜索内容会发送至智谱开放平台;\`user_id\` 请只传匿名化标识。
|
|
52
|
-
- 常见错误码:1701 并发超限(稍后重试)、1702 无可用搜索服务、1703 未返回有效数据(调整查询)。
|
|
53
|
-
`;
|
|
54
|
-
}
|