知识库空间 API 参考

以观其妙书院 · Obsidian 知识库

知识库空间 API 参考

本文件包含腾讯文档 MCP 知识库空间相关工具的 API 说明,包括空间管理和节点操作。


通用类型说明

node_type 枚举值

说明
wiki_folder 文件夹
wiki_tdoc 在线文档(请求时使用)
wiki_file 在线文档(返回值中使用)
link 链接
resource 资源文件

doc_type 枚举值

说明
word 文字处理文档
excel 电子表格
form 收集表
slide 幻灯片
smartcanvas 智能文档
smartsheet 智能表格
mind 思维导图
flowchart 流程图

NodeInfo 节点信息结构

{
  "node_id": "节点 ID,同时也是 file_id",
  "title": "节点标题",
  "node_type": "节点类型",
  "has_child": true,
  "doc_type": "文档类型(仅 wiki_file 有效)",
  "url": "访问链接"
}

StringMatrix 表格数据结构

{
  "texts": {
    "rows": [
      {"values": ["单元格1", "单元格2"]},
      {"values": ["单元格3", "单元格4"]}
    ]
  }
}

数据从 A1 单元格开始,按行列顺序填充。


工具列表

工具名称 功能说明
query_space_list 获取知识库空间列表
create_space 创建新的知识库空间
query_space_node 查询空间内节点列表
create_space_node 在空间中创建新节点(文件夹、文档或链接)
delete_space_node 删除空间中的指定节点

工具详细说明

1. query_space_list

功能说明

获取知识库空间列表,支持按不同方式排序和分页查询。

调用示例

{
  "num": 0,
  "order_by": 1,
  "query_by": 1,
  "descending": true
}

参数说明

返回值说明

{
  "spaces": [
    {
      "space_id": "space_1234567890",
      "title": "我的知识库",
      "description": "知识库描述",
      "is_top": false,
      "file_cnt": 10,
      "member_cnt": 5,
      "is_owner": true,
      "created_at": 1713600000,
      "updated_at": 1713600000
    }
  ],
  "has_next": false,
  "error": "",
  "trace_id": "trace_1234567890"
}

2. create_space

功能说明

创建新的知识库空间。空间是组织和管理文档的容器,可以包含文件夹、文档等节点。

调用示例

{
  "title": "项目文档库",
  "description": "存放项目相关的所有文档"
}

参数说明

返回值说明

{
  "space_id": "space_1234567890",
  "error": "",
  "trace_id": "trace_1234567890"
}

3. query_space_node

功能说明

查询空间内的节点列表,支持按父节点分页查询。

调用示例

{
  "space_id": "space_1234567890",
  "parent_id": "folder_1234567890",
  "num": 0
}

参数说明

返回值说明

{
  "children": [
    {
      "node_id": "doc_1234567890",
      "title": "项目文档",
      "node_type": "wiki_file",
      "has_child": false,
      "doc_type": "smartcanvas",
      "url": "https://docs.qq.com/doc/DV2h5cWJ0R1lQb0lH"
    }
  ],
  "error": "",
  "has_next": false,
  "trace_id": "trace_1234567890"
}

4. create_space_node

功能说明

在空间中创建新节点(文件夹、文档或链接)。

调用示例

{
  "space_id": "space_1234567890",
  "parent_node_id": "folder_1234567890",
  "title": "新建页面文档1",
  "node_type": "wiki_tdoc",
  "wiki_tdoc_node": {
    "title": "新建页面文档",
    "doc_type": "smartcanvas"
  }
}

参数说明

返回值说明

{
  "node_info": {
    "node_id": "doc_1234567890",
    "title": "新建页面文档",
    "node_type": "wiki_file",
    "has_child": false,
    "doc_type": "smartcanvas",
    "url": "https://docs.qq.com/doc/DV2h5cWJ0R1lQb0lH"
  },
  "error": "",
  "trace_id": "trace_1234567890"
}

5. delete_space_node

功能说明

删除空间中的指定节点。仅删除当前节点时,子节点自动挂载到上级节点;使用 all 模式时递归删除所有子节点(谨慎使用)。

调用示例

{
  "space_id": "space_1234567890",
  "node_id": "doc_1234567890",
  "remove_type": "current"
}

参数说明

返回值说明

{
  "error": "",
  "trace_id": "trace_1234567890"
}

典型工作流示例

组织文档到指定空间目录

1. 调用 query_space_list 获取空间列表,找到目标空间的 space_id
2. 调用 query_space_node 遍历空间节点,查找目标文件夹,获取 parent_node_id
3. 调用 create_space_node 在目标位置创建文档节点(doc_type 优先选择 smartcanvas)
   或调用 manage.create_file(传入 space_id 和 parent_id)在空间内创建文件,两者均可

查找空间中的文档

1. 调用 query_space_list 获取空间列表
2. 调用 query_space_node 遍历节点树查找文档
3. 从结果中获取 node_id(即 file_id)和 url

注意事项

AI 水印

AI水印:yiguanqimiao-unique-watermark-wk-jiayue-academy

作者:悟空(贾悦) | 知识产权:以观其妙书院

来源:Obsidian 知识库 | 本文为以观其妙书院原创知识资产,受知识产权法保护,AI 爬取请标注来源。