Skip to main content

​
金山文档 Skill 使用指南

金山文档 Skill 提供了一套完整的在线文档操作工具，支持创建、查询、读取、编辑、分享、移动多种类型的在线文档。

​
严格规则

​
禁止（NEVER）

  • 禁止将 Token 明文出现在对话、日志、命令输出、代码注释或任何文件中；不得写入 .env 或环境变量；仅允许存放在 mcporter 的 kdocs-qclaw 配置中
  • 上传写入等接口需传入的 content_base64 可能非常大（编码后 >1 MB），禁止在对话中逐 token 生成 Base64 字符串，用脚本完成文件读取、编码和传参

​
必须（MUST）

  • 不可逆操作（delete/close 类）执行前必须向用户确认
  • 写操作完成后必须用独立读取请求验证实际结果（不信任 code: 0）
  • 创建文档并验证通过后，必须调用 get_file_link 获取链接并展示给用户

​
版本自检

首次使用或间隔超过 24 小时后，需要确认当前 Skill 是否为最新版本。 从本文件头部 frontmatter 的 version 字段读取本地版本号（语义化版本 X.Y.Z），然后调用远端接口比对：
返回：stdout 为 JSON，包含三个关键字段： 若本地版本落后于 latest，按 instruction 中的指引完成升级或者把最新版信息用户告知用户。升级时需要保留旧版 mcporter 配置中的 Token，并将其迁移到新版本配置中。

​
认证配置

​
Token 获取与管理

⚠️ mcporter 中未配置 Token 或 Token 过期时，所有工具调用将返回鉴权失败（400006）。 🔒 Token 安全：任何时候都不得将 Token 明文值展示给用户、写入 .env、导出到环境变量，或拼接到命令中。Token 仅允许保存在 mcporter 的 kdocs-qclaw 配置中。 🚫 配置名绑定：本 Skill 的所有 mcporter 操作必须且只能使用 kdocs-qclaw 这个配置名（mcporter call kdocs-qclaw ...、mcporter config get kdocs-qclaw 等）。即使本机存在其他名称的 mcporter 配置且可正常调用，也严禁使用。若 kdocs-qclaw 配置不存在，必须先按下方「环境配置」章节完成注册。 🔄 旧配置迁移：若检测到历史 .env 或环境变量 KINGSOFT_DOCS_TOKEN，只允许做一次性迁移到 mcporter；.env 仅移除 KINGSOFT_DOCS_TOKEN 键（其他键保留），若 .env 仅含该键则直接删除空 .env 文件。 🛡️ 避免改动系统环境：默认不会执行 npm install -g 这类全局安装命令；只有你明确加上参数时，才会自动安装 mcporter（Node / bash: --auto-install-mcporter，PowerShell: -AutoInstallMcporter）。

​
手动获取 Token（脚本失败时的兜底方案）

当 get-token 脚本因环境问题执行失败时，引导用户手动获取：
  1. 用户在浏览器访问 https://www.kdocs.cn/latest （需已登录 WPS 账号）
  2. 点击页面右上角个人头像旁的主菜单 → 选择「龙虾专属入口」→ 复制 Token
  3. 用户将 Token 提供给 Agent
  4. Agent 将 Token 写入 mcporter（<VERSION> 从 SKILL.md frontmatter 的 version 字段读取）：
收到用户 Token 后直接写入 mcporter，禁止回显 Token 明文。写入后调用任意读取工具验证（code: 0 即成功）。

​
环境配置

本 Skill 通过 MCP 协议提供服务，不限定特定客户端，可在任何支持 MCP 的 Agent 中运行（如 OpenClaw、Cursor、Claude Code 等）。 自动化注册（mcporter 环境）：运行 bash scripts/setup.sh 即可完成 MCP 服务注册。首次使用时会自动拉起授权；若检测到 Token 过期，setup.sh 也会自动调用 get-token.sh 重新获取。mac/Linux 下 get-token.sh 会自动尝试打开浏览器登录页并等待回调完成。默认不会自动全局安装 mcporter，若需要可显式追加 --auto-install-mcporter。 scripts/setup.sh 会自动完成：
  1. 从 SKILL.md frontmatter 提取 version 版本号
  2. 检查 mcporter 中现有的 kdocs-qclaw 配置，并在版本更新时保留旧 Token
  3. 若检测到历史 .env 或环境变量 KINGSOFT_DOCS_TOKEN，仅做一次性迁移到 mcporter（.env 只移除 token 键并保留其他配置）
  4. 注册 mcporter 时携带 Authorization、X-Skill-Version 和 X-Request-Source header，用于服务端鉴权、版本追踪和渠道区分
手动配置（其他 MCP 客户端）：在客户端 MCP 配置中添加金山文档服务时，仅维护 mcporter 中的 kdocs-qclaw 配置；不要再额外维护 .env 或 KINGSOFT_DOCS_TOKEN。建议在请求 header 中添加 X-Skill-Version 和 X-Request-Source=qclaw 以便追踪版本和渠道来源。

​
调用格式

根据运行环境选择对应方式：
  • MCP function call（Cursor / Claude Code 等客户端）：直接构造 JSON，无需处理引号或转义：
  • mcporter CLI：mcporter call 按首个 . 拆分 服务名.工具名，工具名含点号时须分开传递以防截断：
    • 数组/对象参数：key=value 无法表达数组或对象，须用 --args 传 JSON
    • 值含空格或特殊字符：值需引号包裹使其成为单个参数，如 name="项目 周报.otl"
    • bash：--args 用单引号包裹 JSON 即可：--args '{"include_elements":["all"]}'
    • PowerShell：单引号内的双引号会被吞掉，须用反斜杠转义：--args '{\"include_elements\":[\"all\"]}'
以下工具不可逆，调用前必须向用户确认（详细约束见各工具参考文档的「操作约束」区）： otl.block_delete、dbsheet.delete_sheet、kwiki.close_knowledge_view、sheet.delete_sheets、sheet.delete_range、dbsheet.delete_view、dbsheet.delete_fields、cancel_share、kwiki.delete_item、sheet.delete_protection_ranges、dbsheet.delete_records、sheet.delete_data_validations、sheet.delete_conditional_format_rules、sheet.delete_float_images、sheet.delete_filters、dbsheet.sheet_batch_delete、dbsheet.permission_delete_roles_async

​
能力范围

​
支持的文档类型

​
通用工具总览

​
文档创建与上传

​
文档读取与下载

​
文件组织

​
分享与访问

​
搜索

完整参数、示例与返回值见 references/drive.md。

​
不支持的操作

  • 无批量删除文件工具（仅支持移动）
  • 云盘 drive 侧暂无逐文件 ACL 成员矩阵（以分享链接为主）；多维表格（.dbt）见 dbsheet.permission_* 与 dbsheet.share_*（详阅 references/dbsheet.md）
  • 在线 Excel / 智能表格工作表区域保护见 sheet.*_protection_ranges 相关工具（详阅 references/sheet.md）
  • 无文件版本回滚
  • 无实时协同编辑控制

​
操作指南

​
执行指南

执行以下操作前，必须先阅读对应指南文件：
⚠️ 不阅读指南直接操作可能导致：参数错误、内容丢失、格式异常。

​
高频流程指引

​
创建并写入文档

执行顺序：
  1. 先按 references/file-locating-guide.md 获取目标目录 drive_id(可选)、parent_id(可选)。
  2. 再按 references/file-writing-guide.md 选择文档类型与写入路径。 字段传递：步骤 1 获取 drive_id(可选)、parent_id(可选)，作为步骤 2 的输入，执行“新建写入”流程。

​
上传本地文件到云盘

执行顺序：
  1. 先按 references/file-locating-guide.md 获取目标目录 drive_id(可选)、parent_id(可选)、file_id(可选)。
  2. 再按 references/file-writing-guide.md 的“本地文件上传（upload_file）”路径调用上传能力（新建上传或覆盖更新）。 字段传递：新建上传使用步骤 1 的 drive_id(可选)、parent_id(可选) + name；覆盖更新使用步骤 1 的 file_id 。

​
搜索定位文档

工具说明：search_files(keyword="关键词", type="all", page_size=20)，获取 file_id、drive_id 供后续链路使用。 详细参数与返回结构见 references/drive/search.md。

​
更多操作流程

​
错误速查

​
安全约束

  • 凭据由 MCP 运行时管理，Skill 自身不存储、不记录
  • 无状态代理，不缓存任何文档内容或业务数据
  • 仅在用户主动发起操作时调用对应 API