Files
stock-assistant/skills/tencent-docs/references/manage_references.md
root 691b8cdd0c feat: 初始化黄小瓜AI助手记忆仓库
- 核心配置: IDENTITY, USER, SOUL, AGENTS, TOOLS, HEARTBEAT, MEMORY
- memory/: 每日总结和临时记录
- skills/: 所有已安装技能
- notes/: 语音配置笔记
2026-04-04 02:42:48 +08:00

800 lines
21 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 腾讯文档 MCP 工具完整参考
本文件包含腾讯文档 MCP 中 文件管理类 相关工具的完整 API 说明、支持文件的增删改查、文件搜索、文件夹列表、文件夹信息查询、文档权限设置。
---
## 目录
- [文件夹操作](#文件夹操作)
- [manage.folder_list](#managefolder_list)
- [manage.query_folder_meta](#managequery_folder_meta)
- [文档创建操作](#文档创建操作)
- [manage.create_file](#managecreate_file)
- [文档搜索操作](#文档搜索操作)
- [文档重命名](#文档重命名)
- [云文档最近浏览列表页查询](#云文档最近浏览列表页查询)
- [文档权限设置](#文档权限设置)
- [manage.set_privilege](#manageset_privilege)
- [文档导入操作](#文档导入操作)
- [manage.import_file](#manageimport_file)
- [manage.import_progress](#manageimport_progress)
- [文档导出操作](#文档导出操作)
- [manage.export_file](#manageexport_file)
- [manage.export_progress](#manageexport_progress)
- [典型工作流示例](#典型工作流示例)
---
## 文件夹操作
### manage.folder_list
**功能**:拉取指定目录下的文件与文件夹列表。
**使用场景**
- 查看根目录或指定文件夹下的所有文件和子文件夹
- 在创建文档前先获取目标文件夹的 ID
- 浏览用户的云文档目录结构
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `folder_id` | string | | 文件夹ID默认为空表示查询根目录下的文件 |
| `start` | integer | | 查询记录的起始位置默认为0 |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `list[].id` | string | 文件/文件夹 ID |
| `list[].title` | string | 文件/文件夹标题 |
| `list[].url` | string | 文件链接 |
| `list[].is_folder` | boolean | 是否为文件夹,`true` 表示文件夹,`false` 表示文件 |
| `finish` | boolean | 列表分页是否查完,`false` 表示还有分页未查到,`true` 表示所有分页都查询完成 |
**调用示例(查询根目录)**
```json
{}
```
**调用示例(查询指定文件夹)**
```json
{
"folder_id": "folder_abc123",
"start": 0
}
```
**返回示例**
```json
{
"list": [
{
"id": "folder_001",
"title": "项目文档",
"url": "",
"is_folder": true
},
{
"id": "doc_001",
"title": "会议纪要",
"url": "https://docs.qq.com/doc/DV2h5cWJ0R1lQb0lH",
"is_folder": false
}
],
"finish": false,
"trace_id": "trace_xyz"
}
```
> **注意**
> - 返回结果中 `is_folder=true` 的条目为文件夹,其 `id` 可作为 `folder_id` 继续查询子目录内容
> - 当 `finish=false` 时,需增大 `start` 参数值进行翻页查询
---
### manage.query_folder_meta
**功能**查询指定文件夹的元信息meta支持根据 folderID 查询。
**使用场景**
- 查询某个文件夹的详细信息(名称、创建时间等)
- 验证文件夹 ID 是否有效
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `folder_id` | string | ✅ | 文件夹ID |
**调用示例**
```json
{
"folder_id": "folder_abc123"
}
```
---
## 文档创建操作
### manage.create_file
**功能**:创建腾讯云文档,支持创建多种类型的文档。
**使用场景**
- 在指定文件夹下创建新的在线文档(如文档、表格、幻灯片等)
- 传入 `space_id` 时,在知识库空间中创建文档节点(兼容 `create_space_node` 能力)
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `title` | string | ✅ | 文件标题长度不超过36字符 |
| `file_type` | string | ✅ | 文件类型,详见下方取值说明 |
| `parent_id` | string | | 父节点ID。不传 `space_id` 时表示个人文件夹唯一标识;传入 `space_id` 时表示空间父节点ID为空则在个人首页或空间根路径创建 |
| `space_id` | string | | 知识库空间ID传入时在空间中创建节点不传时在个人首页中创建文件 |
| `link_node` | object | | 空间链接节点配置信息,`file_type``wikilink` 时必填,包含 `link_url`(必填)和 `link_description` |
**file_type 取值说明**
| 值 | 含义 | 支持场景 |
|-----------------|----------|---------|
| `smartcanvas` | 智能文档 | 个人首页 / 空间 |
| `doc` | Word | 个人首页 / 空间 |
| `sheet` | 表格 | 个人首页 / 空间 |
| `form` | 收集表 | 个人首页 / 空间 |
| `slide` | 幻灯片 | 个人首页 / 空间 |
| `mind` | 思维导图 | 个人首页 / 空间 |
| `flowchart` | 流程图 | 个人首页 / 空间 |
| `smartsheet` | 智能表格 | 个人首页 / 空间 |
| `folder` | 文件夹 | 个人首页 / 空间 |
| `wikilink` | 空间链接 | 仅空间(需传 `space_id` |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `file_id` | string | 文件ID文档ID、文件夹ID 或空间内节点ID |
| `title` | string | 文件名称 |
| `url` | string | 文件链接 |
| `type` | string | 文件类型 |
| `space_id` | string | 空间ID在空间内创建文件时返回 |
| `error` | string | 错误信息(如有) |
**调用示例**
```json
{
"title": "项目计划",
"file_type": "doc"
}
```
**返回示例**
```json
{
"file_id": "doc_1234567890",
"title": "项目计划",
"url": "https://docs.qq.com/doc/DV2h5cWJ0R1lQb0lH",
"type": "doc",
"space_id": "",
"error": "",
"trace_id": "trace_xyz"
}
```
---
## 文档搜索操作
### manage.search_file
**功能**:根据关键词搜索云文档,返回匹配关键词的文档列表。
**使用场景**
- 搜索文档标题包含"MCP"关键字的文档
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------------------------------------------------------|
| `search_key` | string | ✅ | 搜索关键字 |
**返回字段**
| 字段 | 类型 | 说明 |
|----------------|--------|----------|
| `list[].file_id` | string | 文档id |
| `list[].title` | string | 文档标题 |
| `list[].url` | string | 文档链接 |
**调用示例**
```json
{
"search_key": "MCP"
}
```
**返回示例**
```json
{
"list":[
{
"file_id": "sheet_1",
"title": "sheet_name_1",
"url": "https://docs.qq.com/sheet/sheet_file_id_1"
},
{
"file_id": "sheet_2",
"title": "sheet_name_2",
"url": "https://docs.qq.com/sheet/sheet_file_id_2"
}
],
"trace_id": "trace_xyz"
}
```
---
## 文档重命名
### manage.rename_file_title
**功能**根据云文档ID更新文档标题。
**使用场景**
- 将文档(file_id)标题更新为"MCP重命名"
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|-------------------------|
| `file_id` | string | ✅ | 文档ID |
| `title` | string | ✅ | 文档标题 |
**返回字段**
| 字段 | 类型 | 说明 |
|----------------|--------|------------|
| `file_id` | string | 文档ID |
| `title` | string | 文档新标题 |
**调用示例**
```json
{
"file_id": "MCP",
"title": "title"
}
```
**返回示例**
```json
{
"file_id": "MCP",
"title": "new_title",
"trace_id": "trace_xyz"
}
```
---
## 云文档最近浏览列表页查询
### manage.recent_online_file
**功能**:查询云文档最近浏览页文档列表
**使用场景**
- 用户查询最近查看或者编辑过的文档列表
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|----------------|
| `num` | uint32 | ✅ | 当前查询页码数从1开始 |
| `count` | uint32 | | 分页条数默认为100每页最多查询的记录数量 |
| `order_by` | uint32 | | 排序方式0-按文档查看时间排序默认1-按文件修改时间排序2-按文档名称排序 |
**返回字段**
| 字段 | 类型 | 说明 |
|---------------------|--------|------|
| `files[].file_id` | string | 文档ID |
| `files[].file_name` | string | 文档标题 |
| `files[].file_url` | string | 文档链接 |
**调用示例**
```json
{
"num": "1"
}
```
**返回示例**
```json
{
"file":[
{
"file_id": "file_1",
"file_name": "file_name_1",
"file_url": "xxx"
},
{
"file_id": "file_2",
"file_name": "file_name_2",
"file_url": "xxx"
}
],
"trace_id":"trace_abc"
}
```
---
## 文档权限管理
### manage.get_privilege
**功能**根据文档ID查询文档权限策略。返回当前文档的权限设置仅支持返回 0私密文档、1部分成员可见、2所有人可读、3所有人可编辑四种权限场景其他权限类型暂不支持。
**使用场景**
- 查看文档当前的权限状态,决定是否需要调整
- 在设置权限前先查询当前状态,避免重复设置
- 确认文档分享权限是否符合预期
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `file_id` | string | ✅ | 文档ID |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `file_id` | string | 文档ID |
| `policy` | uint32 | 权限策略0-私密文档1-部分成员可见2-所有人可读3-所有人可编辑 |
**policy 返回值说明**
| 值 | 含义 | 说明 |
|----|------|------|
| 0 | 私密文档 | 仅文档所有者可访问 |
| 1 | 部分成员可见 | 仅指定的协作者可访问 |
| 2 | 所有人可读 | 任何获得链接的人都可以查看文档 |
| 3 | 所有人可编辑 | 任何获得链接的人都可以编辑文档 |
> ⚠️ **注意**当前仅支持返回上述四种权限场景0/1/2/3如果文档设置了其他权限类型如所有人可执行、所有人可标注等将返回错误。
**调用示例**
```json
{
"file_id": "DtDywXFgYFru"
}
```
**返回示例**
```json
{
"file_id": "DtDywXFgYFru",
"policy": 2
}
```
---
### manage.set_privilege
**功能**根据文档ID设置文档权限。当前仅支持设置文档为所有人可读或所有人可编辑。
**使用场景**
- 创建文档后设置为所有人可查看,方便团队成员浏览
- 设置文档为所有人可编辑,支持多人协作编辑
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `file_id` | string | ✅ | 文档ID |
| `policy` | uint32 | ✅ | 权限策略2-所有人可读3-所有人可编辑 |
**policy 取值说明**
| 值 | 含义 | 说明 |
|----|------|------|
| 2 | 所有人可读 | 任何获得链接的人都可以查看文档 |
| 3 | 所有人可编辑 | 任何获得链接的人都可以编辑文档 |
> ⚠️ **注意**:目前仅支持 policy=2所有人可读和 policy=3所有人可编辑两种权限设置其他权限值暂不支持。
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `trace_id` | string | 请求追踪ID |
**调用示例(设置所有人可读)**
```json
{
"file_id": "DtDywXFgYFru",
"policy": 2
}
```
**调用示例(设置所有人可编辑)**
```json
{
"file_id": "DtDywXFgYFru",
"policy": 3
}
```
**返回示例**
```json
{
"trace_id": "trace_xyz"
}
```
---
## 文档导入操作
### manage.import_file
**功能**将本地文件导入到腾讯云文档。调用后返回task_id必须配合 `manage.import_progress` 轮询查询导入进度建议间隔3-5秒直到progress=100表示导入完成。
**使用场景**
- 将本地 docx/xlsx/pptx 等文件导入为腾讯云文档在线文档
- 批量迁移本地文件到云端
**支持的文件格式**`xls``xlsx``csv``doc``docx``txt``text``ppt``pptx``pdf``xmind`
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `file_name` | string | ✅ | 文件名称(含后缀),如 `report.docx`。支持的文件后缀有xls,xlsx,csv,doc,docx,txt,text,ppt,pptx,pdf,xmind |
| `file_size` | integer | ✅ | 文件大小,单位为字节(bytes),如 `36752` |
| `file_md5` | string | ✅ | 文件的MD5哈希值hex编码的32位小写字符串`d41d8cd98f00b204e9800998ecf8427e` |
| `file_base64` | string | ✅ | 文件完整内容经标准Base64编码(StdEncoding)后的字符串注意不是URL-safe编码 |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `task_id` | string | 导入任务 ID用于查询导入进度 |
**调用示例**
```json
{
"file_name": "report.docx",
"file_size": 36752,
"file_md5": "a1b2c3d4e5f6...",
"file_base64": "UEsDBBQAAAAI..."
}
```
**返回示例**
```json
{
"task_id": "144115210435508643_e52cf886-5eae-e61c-c828-a0dddb59703d",
"trace_id": "trace_xyz"
}
```
> **注意**:由于 `file_base64` 字段可能非常大(文件越大 Base64 字符串越长),建议通过 Python 脚本等方式直接构造 HTTP 请求调用 MCP 接口,避免 AI 模型逐 token 生成 Base64 字符串导致超时或截断。
---
### manage.import_progress
**功能**:根据导入任务 `task_id` 查询导入进度。每隔3-5秒轮询一次当progress=100时表示导入完成此时返回file_id和file_url。
**使用场景**
- 调用 `manage.import_file` 后轮询查询导入状态
- 导入完成后获取生成的云文档 ID 和访问链接
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `task_id` | string | ✅ | 导入任务 ID`manage.import_file` 返回) |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `progress` | integer | 导入进度百分比0-100 |
| `status` | string | 任务状态 |
| `file_id` | string | 导入完成后的云文档 ID |
| `file_name` | string | 文档名称 |
| `file_url` | string | 文档访问链接 |
| `error` | string | 错误信息(失败时返回) |
**调用示例**
```json
{
"task_id": "144115210435508643_e52cf886-5eae-e61c-c828-a0dddb59703d"
}
```
**返回示例(进行中)**
```json
{
"progress": 25,
"trace_id": "trace_xyz"
}
```
**返回示例(完成)**
```json
{
"progress": 100,
"file_id": "DjVlDHwqVVzs",
"file_name": "report",
"file_url": "https://docs.qq.com/doc/DRGpWbERId3FWVnpz",
"trace_id": "trace_xyz"
}
```
---
## 文档导出操作
### manage.export_file
**功能**:根据云文档 ID 发起导出任务,返回导出任务 ID。需配合 `manage.export_progress` 轮询查询导出进度建议间隔3-5秒导出完成后获取file_url下载链接带签名的临时URL有效期约30分钟
**使用场景**
- 将云端在线文档导出为本地 docx/xlsx/pptx 文件
- 备份云文档到本地
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `file_id` | string | ✅ | 云文档 ID |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `task_id` | string | 导出任务 ID用于查询导出进度 |
**调用示例**
```json
{
"file_id": "DAJpzYoLEpWS"
}
```
**返回示例**
```json
{
"task_id": "144115210435508643_0e15f9be-a2ed-b40a-27c2-10561b7c5072",
"trace_id": "trace_xyz"
}
```
---
### manage.export_progress
**功能**:根据导出任务 `task_id` 查询导出进度。每隔3-5秒轮询一次当progress=100时表示导出完成此时返回file_url带签名的临时下载链接有效期约30分钟
**使用场景**
- 调用 `manage.export_file` 后轮询查询导出状态
- 导出完成后获取文件下载 URL通过 curl 等工具下载到本地
**请求参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|-----|------|
| `task_id` | string | ✅ | 导出任务 ID`manage.export_file` 返回) |
**返回字段**
| 字段 | 类型 | 说明 |
|------|------|------|
| `progress` | integer | 导出进度百分比0-100100表示导出完成 |
| `status` | string | 任务状态 |
| `file_name` | string | 导出的文件名 |
| `file_url` | string | 文件下载链接导出完成后返回带签名的临时URL有效期约30分钟 |
| `error` | string | 错误信息(失败时返回) |
**调用示例**
```json
{
"task_id": "144115210435508643_0e15f9be-a2ed-b40a-27c2-10561b7c5072"
}
```
**返回示例(进行中)**
```json
{
"progress": 50,
"trace_id": "trace_xyz"
}
```
**返回示例(完成)**
```json
{
"progress": 100,
"file_name": "mcp_import.docx",
"file_url": "https://docs-import-export-xxx.cos.ap-guangzhou.myqcloud.com/export/docx/...",
"trace_id": "trace_xyz"
}
```
> **注意**`file_url` 为带签名的临时下载链接,有效期约 30 分钟,需及时下载。可通过 `curl -L -o <本地路径> "<file_url>"` 命令保存到本地。
---
## 典型工作流示例
### 工作流一:从零在指定目录下创建指定品类文档
```
步骤 1获取文件夹列表
→ manage.folder_list判断is_folder=true后获取文件夹id
步骤 2创建指定品类文档
→ manage.create_file传入文件夹id和品类枚举
```
### 工作流二:按照关键字搜索文件列表
```
步骤 1搜索文档
→ manage.search_file传入用户指定的关键词
步骤 2处理数据
→ 从返回的文档列表中获取所需的文档信息
```
### 工作流三:给指定文档生成副本到指定目录
```
步骤 1获取文件夹列表
→ manage.folder_list判断is_folder=true后获取文件夹ID
步骤 2按照指定文档ID生成副本
→ manage.copy_file传入文件夹ID和待生成副本的文档ID
```
### 工作流四:根据关键词搜索后删除文档
```
步骤 1搜索文档
→ manage.search_file传入用户指定的关键词获取文档id
步骤 2删除文档
→ manage.delete_file传入指定的file_id
```
### 工作流五:将本地文件导入为云文档
```
步骤 1读取本地文件并编码
→ 读取本地文件的二进制内容
→ 计算文件大小file_size单位字节
→ 计算文件 MD5 哈希值file_md5
→ 将文件内容进行 Base64 编码file_base64
步骤 2调用导入接口
→ manage.import_file传入 file_name、file_size、file_md5、file_base64
→ 返回 task_id
步骤 3轮询查询导入进度
→ manage.import_progress传入 task_id
→ 每隔 3-5 秒轮询一次,直到 progress=100 或返回错误
→ 导入完成后获取 file_id 和 file_url
```
> **特别说明**:由于 `file_base64` 字段数据量大,建议通过 Python 脚本直接构造 HTTP 请求调用 MCP 接口,
> 而非由 AI 模型逐 token 生成 Base64 字符串。示例脚本流程:
> 1. 用 Python 读取文件并计算 md5、base64
> 2. 构造 JSON-RPC 请求体method: `tools/call`, tool: `manage.import_file`
> 3. POST 到 MCP 端点 `https://docs.qq.com/openapi/mcp`(携带 Authorization 和 Cookie 头)
> 4. 拿到 task_id 后通过 `manage.import_progress` 查询进度
### 工作流六:将云文档导出到本地
```
步骤 1发起导出任务
→ manage.export_file传入 file_id
→ 返回 task_id
步骤 2轮询查询导出进度
→ manage.export_progress传入 task_id
→ 每隔 3-5 秒轮询一次,直到 progress=100 或返回错误
→ 导出完成后获取 file_url临时下载链接
步骤 3下载文件到本地
→ 使用 curl 或其他 HTTP 工具下载文件
→ curl -L -o <本地保存路径> "<file_url>"
```
> **注意事项**
> - 导出的下载链接file_url为带签名的临时 URL有效期约 30 分钟,需及时下载
> - 导出的文件格式取决于原始文档类型doc→docxsheet→xlsxslide→pptx 等)
### 工作流七:导入本地文件后再导出验证(完整闭环)
```
步骤 1导入本地文件
→ 按工作流五执行导入操作
→ 记录返回的 file_id
步骤 2导出刚导入的文件
→ manage.export_file传入步骤 1 返回的 file_id
→ 返回 task_id
步骤 3轮询导出进度并下载
→ manage.export_progress传入 task_id
→ 导出完成后通过 file_url 下载到本地
步骤 4验证文件完整性
→ 对比原文件与导出文件的大小(可能有微小差异,属正常现象)
→ 导入导出过程中腾讯文档会对文件内部 XML 结构做标准化处理
```
### 工作流八:创建文档并设置分享权限
```
步骤 1创建文档
→ create_smartcanvas_by_markdown传入标题和Markdown内容
→ 返回 file_id 和 url
步骤 2设置文档权限
→ manage.set_privilege传入 file_id 和 policy
→ policy=2 设置所有人可读policy=3 设置所有人可编辑
步骤 3分享文档链接
→ 将步骤 1 返回的 url 分享给相关人员
```
### 工作流九:查询文档权限后按需调整
```
步骤 1查询文档当前权限
→ manage.get_privilege传入 file_id
→ 返回 policy0-私密文档、1-部分成员可见、2-所有人可读、3-所有人可编辑
步骤 2根据需要调整权限
→ 如果 policy 不符合预期,调用 manage.set_privilege传入 file_id 和目标 policy
→ policy=2 设置所有人可读policy=3 设置所有人可编辑
```