tencent-docs

Original🇨🇳 Chinese
Translated
1 scripts

Tencent Docs, provides comprehensive operation capabilities for Tencent Docs. Use this skill when users need to operate Tencent Docs, including: (1) Create various online documents (SmartCanvas, Word, Excel, Slide, Mind Map, Flowchart) (2) Query and search document spaces and files (3) Manage space nodes and folder structures (4) Read document content (5) Edit SmartSheet (6) Edit SmartCanvas.

4installs
Added on

NPX Install

npx skill4agent add zrong/skills tencent-docs

SKILL.md Content (Chinese)

View Translation Comparison →

Tencent Docs MCP Usage Guide

Tencent Docs MCP provides a complete set of online document operation tools, supporting the creation, query and editing of multiple types of online documents.

📚 Detailed Reference Documents

For detailed call examples, parameter descriptions and return value explanations of each tool, please refer to:
  • references/api_references.md
    - Contains complete call examples, parameter descriptions, return value explanations, as well as API structure and enumeration value explanations for all tools
  • references/smartsheet_references.md
    - Special reference document for SmartSheet, including field type enumerations, field value format references, typical workflow examples and detailed explanations of all
    smartsheet.*
    tools
  • references/smartcanvas_references.md
    - Special reference document for SmartCanvas, including element type explanations, rich text format enumerations, typical workflow examples and detailed explanations of all
    smartcanvas.*
    tools

⚙️ Configuration Requirements

Choose the corresponding configuration method according to your environment:

✅ Scenario 1: CodeBuddy / Other IDEs (Recommended)

No additional installation required, you can directly use it by adding the Tencent Docs service in the IDE's MCP configuration.
Configuration Steps:
  1. Visit https://docs.qq.com/open/document/mcp/get-token/ to obtain your personal Token
  2. Add the following service in the IDE's MCP configuration:
json
{
  "mcpServers": {
    "tencent-docs": {
      "url": "https://docs.qq.com/openapi/mcp",
      "headers": {
        "Authorization": "Your Token Value"
      }
    }
  }
}
⚠️ Important: The key of the Header must be
Authorization
, do not use other names (such as
token
,
auth
,
X-Token
, etc.), otherwise authentication will fail.
  1. After configuration is completed, you can directly call all Tencent Docs tools in the IDE without any additional steps.

🔧 Scenario 2: OpenClaw (Requires Installation)

When using in OpenClaw, you need to complete local installation and registration first.
Installation Steps:
  1. Visit https://docs.qq.com/open/document/mcp/get-token/ to obtain the Token, and configure the environment variable:
bash
export TENCENT_DOCS_TOKEN="Your Token Value"
  1. Run setup.sh to complete MCP service registration:
bash
bash setup.sh
setup.sh will automatically register the Tencent Docs MCP service to mcporter and verify whether the configuration is successful. If setup is not executed, all tool calls will fail to find the
tencent-docs
service.
  1. Verify whether the installation is successful:
bash
mcporter list | grep tencent-docs
⚠️ If the user has not configured the Token, please guide the user to visit the above link to obtain the Token, otherwise all tool calls will return authentication failure.

🔧 Calling Method

The standard configuration name of Tencent Docs MCP is
tencent-docs
, call tools directly through the built-in MCP Client:
mcp: tencent-docs
tool: <Tool Name>
arguments: { ... }

Complete List of Supported Tools

⚠️ The following tool list is for reference only, the actual available tools are subject to the results returned by calling the
tools/list
interface.
Get the latest tool list:
mcp: tencent-docs
method: tools/list
Tool NameMCP Call FormatFunction Description
create_smartcanvas_by_markdown
create_smartcanvas_by_markdown
⭐ Create SmartCanvas (Recommended)
create_excel_by_markdown
create_excel_by_markdown
Create Excel Spreadsheet
create_slide_by_markdown
create_slide_by_markdown
Create Slide
create_mind_by_markdown
create_mind_by_markdown
Create Mind Map
create_flowchart_by_mermaid
create_flowchart_by_mermaid
Create Flowchart
create_word_by_markdown
create_word_by_markdown
Create Word Document
query_space_node
query_space_node
Query Space Node
create_space_node
create_space_node
Create Space Node
delete_space_node
delete_space_node
Delete Space Node
search_space_file
search_space_file
Search Space File
get_content
get_content
Get Document Content
batch_update_sheet_range
batch_update_sheet_range
Batch Update Spreadsheet
smartcanvas.*See Section 4 belowSmartCanvas Element Operations (Page/Text/Heading/To-Do Item), see
references/smartcanvas_references.md
for details
smartsheet.*See Section 5 belowSmartSheet Operations (Worksheet/View/Field/Record), see
references/smartsheet_references.md
for details
For detailed call examples, please refer to:
references/api_references.md

⭐ Important: Document Type Selection Guide

Highly Recommended: SmartCanvas
  • New Document: Prioritize using
    create_smartcanvas_by_markdown
    to create SmartCanvas, for the following reasons:
    • 📝 More beautiful layout with automatically optimized arrangement
    • 🎨 Supports richer formats (headings, paragraphs, lists, tables, code blocks, quotes, images, etc.)
    • 📱 Consistent display effect across platforms
  • Edit Existing Document: Use
    smartcanvas.*
    series tools to perform CRUD operations on existing SmartCanvas, see
    references/smartcanvas_references.md
    for details

Document Type Selection Decision Tree

What type of content do you need to create?
├─ New general document content (reports, notes, articles, etc.)
│   └─ ✅ Use create_smartcanvas_by_markdown (Recommended)
├─ Edit/append content to existing SmartCanvas
│   └─ ✅ Use smartcanvas.* tools (see `references/smartcanvas_references.md` for details)
├─ Data spreadsheet (requires calculation, filtering, statistics)
│   └─ ✅ Use create_excel_by_markdown
├─ Presentation (requires page-by-page display, projection presentation)
│   └─ ✅ Use create_slide_by_markdown
├─ Hierarchical knowledge organization (knowledge graph, outline)
│   └─ ✅ Use create_mind_by_markdown
├─ Process/architecture display (flowchart, sequence diagram)
│   └─ ✅ Use create_flowchart_by_mermaid
├─ Structured data management (multi-view, field management, kanban)
│   └─ ✅ Use smartsheet.* tools (see `references/smartsheet_references.md` for details)
└─ Traditional Word format export requirement
    └─ Use create_word_by_markdown (only when explicitly needed)

Supported Document Types

Typedoc_typeRecommendationDescription
SmartCanvassmartcanvas⭐⭐⭐ RecommendedBeautiful layout, supports rich components
Excelexcel⭐⭐⭐Specialized for data spreadsheets
Slideslide⭐⭐⭐Specialized for presentations
Mind Mapmind⭐⭐⭐Specialized for knowledge graphs
Flowchartflowchart⭐⭐⭐Specialized for process display
Wordword⭐⭐Traditional format with average layout
Formform⭐⭐Form collection
SmartSheetsmartsheet⭐⭐⭐Advanced structured spreadsheet, supports multi-view and field management
Boardboard⭐⭐Online whiteboard

Tool List

📖 For complete call examples, parameter descriptions and return value explanations of all tools, please refer to
references/api_references.md
⚠️ The tool list in this skill is only for usage guidance, the actual available tools are subject to the results returned by calling the
tools/list
interface.
If a tool does not exist or parameters do not match, please execute
tools/list
first to get the latest tool definition.

1. Document Creation Tools

⭐ create_smartcanvas_by_markdown (Recommended)

Recommended tool for general documents, create SmartCanvas via Markdown with beautiful layout, supporting all basic Markdown structures.
Applicable Scenarios:
  • 📄 Documents, reports, notes, articles
  • 📋 Meeting minutes, program descriptions
  • 📚 Technical documents, tutorials
  • 🗒️ Any content requiring beautiful layout
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_smartcanvas_by_markdown

create_excel_by_markdown

Create Excel via Markdown table, suitable for scenarios requiring data calculation and filtering.
Applicable Scenarios: Data reports, statistical spreadsheets, scenarios requiring formula calculation
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_excel_by_markdown

create_slide_by_markdown

Create Slide via Markdown, following a specific hierarchical structure (
#
Main Title →
##
Chapter →
###
Page →
-
Paragraph → Indented Sub-item Content).
Applicable Scenarios: Presentations, project reports, training materials
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_slide_by_markdown

create_mind_by_markdown

Create Mind Map via Markdown, using heading levels and list nesting to represent the structure.
Applicable Scenarios: Knowledge graphs, outline organization, brainstorming
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_mind_by_markdown

create_flowchart_by_mermaid

Create Flowchart via Mermaid syntax, the content of the mermaid field must be in English entirely.
Applicable Scenarios: Flowcharts, sequence diagrams, architecture diagrams
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_flowchart_by_mermaid

create_word_by_markdown

Create Word Document via Markdown. Note: Use only when the user explicitly requires Word format, otherwise use SmartCanvas.
Supports
parent_id
parameter
: You can specify the parent node ID to create the document in the specified directory; if not filled, it will be created in the root directory.
📖 For call examples, please refer to:
references/api_references.md
- create_word_by_markdown

2. Workspace Management Tools

query_space_node

Query the space node tree structure to get the list of folders and documents. Supports pagination, returns 20 items per page.
📖 For call examples, please refer to:
references/api_references.md
- query_space_node

create_space_node

Create a new node in the space, supporting the creation of folders (
wiki_folder
), online documents (
wiki_tdoc
), and links (
link
).
📖 For call examples, please refer to:
references/api_references.md
- create_space_node

search_space_file

Search documents in the space, supports keyword matching of titles and content, supports pagination, returns 40 items per page.
⚠️ Note: Only document-type nodes (word, excel, slide, etc.) can be searched, folders cannot be searched; if you need to find folders, please use
query_space_node
to traverse the node tree.
📖 For call examples, please refer to:
references/api_references.md
- search_space_file

delete_space_node

Delete the specified node in the space, supporting two deletion modes.
Deletion Type (remove_type):
  • current
    (default): Only delete the current node, child nodes will be automatically mounted to the parent node
  • all
    : Delete the current node and all its child nodes (⚠️ Use with caution, will recursively delete all child nodes)
📖 For call examples, please refer to:
references/api_references.md
- delete_space_node

3. Document Operation Tools

get_content

Get the complete content of the document, pass in
file_id
to return the document body text.
📖 For call examples, please refer to:
references/api_references.md
- get_content

batch_update_sheet_range

Batch update spreadsheet cell content (only applicable to Excel), data is appended from the end of the spreadsheet without overwriting existing content.
📖 For call examples, please refer to:
references/api_references.md
- batch_update_sheet_range

smartcanvas.create_smartcanvas_element

Add elements to an existing SmartCanvas, supporting the addition of multiple types of elements such as Page, Text, Heading, Task, etc.
Element Hierarchy Constraints:
  • Text
    ,
    Task
    ,
    Heading
    must be mounted under a
    Page
    type parent node (
    parent_id
    is required)
  • Page
    does not need to specify a parent node, it will be inserted into the root node
  • Parent node does not support
    Heading
    type
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.create_smartcanvas_element

smartcanvas.get_element_info

Batch query detailed information of specified elements, supporting simultaneous query of content, type, parent-child relationship, etc. of multiple elements.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.get_element_info

smartcanvas.get_page_info

Query all elements in the specified page, supports pagination acquisition. Use the
cursor
parameter for pagination,
is_over=true
indicates that all content has been obtained.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.get_page_info

smartcanvas.get_top_level_pages

Query the list of all top-level pages of the document, returns the direct child pages under the root node, used to understand the document directory structure.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.get_top_level_pages

smartcanvas.update_element

Batch modify element content, supporting simultaneous update of attributes such as text, format, heading level, page title of multiple elements.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.update_element

smartcanvas.delete_element

Batch delete elements, supporting simultaneous deletion of multiple specified elements.
⚠️ When deleting a Page element, all its child elements will also be deleted, please use with caution.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.delete_element

smartcanvas.append_insert_smartcanvas_by_markdown

Append content to an existing SmartCanvas via Markdown text, content is appended to the end of the document.
📖 For complete description, please refer to:
references/smartcanvas_references.md
- smartcanvas.append_insert_smartcanvas_by_markdown

4. SmartCanvas Element Operation Tools

SmartCanvas supports complete CRUD operations on elements such as pages, text, headings, to-do items, with a total of 7 tools (
smartcanvas.*
).
📖 For complete description of all tools (usage scenarios, element type definitions, enumerations, parameter examples), please refer to:
references/smartcanvas_references.md
Includes: element addition, element query, page content query, top-level page query, element modification, element deletion, Markdown append, as well as heading level enumerations, color enumerations, rich text format descriptions, typical workflow examples.

5. SmartSheet Operation Tools

SmartSheet supports complete CRUD operations on worksheets, views, fields, records, with a total of 12 tools (
smartsheet.*
).
📖 For complete description of all tools (usage scenarios, field definitions, enumerations, parameter examples), please refer to:
references/smartsheet_references.md
Includes: worksheet operations, view operations, field operations, record operations, as well as field type enumerations, field value format references, typical workflow examples.

Common Workflows

Create General Document (Recommended Method)

1. Prioritize calling create_smartcanvas_by_markdown to create SmartCanvas
2. Get file_id and url from the returned result

Edit Existing SmartCanvas

1. Call smartcanvas.get_top_level_pages to get the document page structure
2. Call smartcanvas.* tools to perform CRUD operations as needed:
   - Append content: smartcanvas.append_insert_smartcanvas_by_markdown (Markdown method)
   - Add elements: smartcanvas.create_smartcanvas_element
   - Query elements: smartcanvas.get_element_info / smartcanvas.get_page_info
   - Modify elements: smartcanvas.update_element
   - Delete elements: smartcanvas.delete_element

Organize Documents into Specified Directory

  1. Call
    query_space_node
    to find the target folder
  2. Call
    create_space_node
    to create a document node in the target location (prefer smartcanvas as doc_type)

Search and Read Document

  1. Call
    search_space_file
    to search for documents
  2. Get
    node_id
    (i.e.,
    file_id
    ) from the results
  3. Call
    get_content
    to get the document content

SmartSheet Operation Workflow

Build Task Management Sheet from Scratch

1. Get worksheet list → smartsheet.list_tables (get sheet_id)
2. Add fields (columns) → smartsheet.add_fields (task name, priority, deadline, etc.)
3. Batch write data → smartsheet.add_records
4. (Optional) Create kanban view → smartsheet.add_view (view_type=2)

Query and Update Data

1. Get worksheet → smartsheet.list_tables
2. Query records → smartsheet.list_records (get record_id)
3. Update records → smartsheet.update_records (pass in record_id and new field values)
📖 For more SmartSheet workflow examples, please refer to:
references/smartsheet_references.md
- Typical Workflow Examples

Notes

  • Default to use SmartCanvas: Unless the user explicitly specifies another format, prioritize using
    create_smartcanvas_by_markdown
    when creating new documents
    ; use
    smartcanvas.*
    series tools when editing existing SmartCanvas
  • parent_id
    supported when creating documents
    : All
    create_*_by_markdown
    and
    create_flowchart_by_mermaid
    tools support the
    parent_id
    parameter, which can directly create documents in the specified directory; if not filled, it will be created in the root directory
  • Delete node:
    delete_space_node
    only deletes the current node by default (
    remove_type=current
    ), using
    all
    will recursively delete all child nodes, please use with caution
  • Markdown content uses UTF-8 format, no need to escape special characters
  • Slides must follow the hierarchical structure, each page contains 2-4 paragraph headings
  • Pagination query returns 20-40 records per page, use
    has_next
    to determine if there are more
  • node_id
    is also the
    file_id
    of the document
  • The mermaid content of
    create_flowchart_by_mermaid
    must be in English entirely
  • SmartCanvas Element Operations:
    Text
    ,
    Heading
    ,
    Task
    must be mounted under Page,
    parent_id
    must be the ID of a Page type element; call
    smartcanvas.get_top_level_pages
    to get the page structure before operation
  • SmartCanvas Pagination Query:
    smartcanvas.get_page_info
    uses
    cursor
    for pagination,
    is_over=true
    indicates that all content has been obtained
  • SmartCanvas Deletion Note: When deleting a Page element, all its child elements will also be deleted
  • SmartSheet Operations: All smartsheet.* tools require
    file_id
    and
    sheet_id
    , call
    smartsheet.list_tables
    to get sheet_id before operation
  • Field type cannot be updated: When using
    update_fields
    , field_type cannot be modified, but the original value must be passed in
  • Record field value format: The value format varies for different field types, see
    references/smartsheet_references.md
    - Field Value Format Reference for details