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
Sourcezrong/skills
Added on
NPX Install
npx skill4agent add zrong/skills tencent-docsTags
Translated version includes tags in frontmatterSKILL.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:
- - Contains complete call examples, parameter descriptions, return value explanations, as well as API structure and enumeration value explanations for all tools
references/api_references.md - - Special reference document for SmartSheet, including field type enumerations, field value format references, typical workflow examples and detailed explanations of all
references/smartsheet_references.mdtoolssmartsheet.* - - Special reference document for SmartCanvas, including element type explanations, rich text format enumerations, typical workflow examples and detailed explanations of all
references/smartcanvas_references.mdtoolssmartcanvas.*
⚙️ 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:
- Visit https://docs.qq.com/open/document/mcp/get-token/ to obtain your personal Token
- 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, do not use other names (such asAuthorization,token,auth, etc.), otherwise authentication will fail.X-Token
- 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:
- 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"- Run setup.sh to complete MCP service registration:
bash
bash setup.shsetup.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 theservice.tencent-docs
- 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 , call tools directly through the built-in MCP Client:
tencent-docsmcp: 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 theinterface.tools/listGet the latest tool list:mcp: tencent-docs method: tools/list
| Tool Name | MCP Call Format | Function Description |
|---|---|---|
| create_smartcanvas_by_markdown | | ⭐ Create SmartCanvas (Recommended) |
| create_excel_by_markdown | | Create Excel Spreadsheet |
| create_slide_by_markdown | | Create Slide |
| create_mind_by_markdown | | Create Mind Map |
| create_flowchart_by_mermaid | | Create Flowchart |
| create_word_by_markdown | | Create Word Document |
| query_space_node | | Query Space Node |
| create_space_node | | Create Space Node |
| delete_space_node | | Delete Space Node |
| search_space_file | | Search Space File |
| get_content | | Get Document Content |
| batch_update_sheet_range | | Batch Update Spreadsheet |
| smartcanvas.* | See Section 4 below | SmartCanvas Element Operations (Page/Text/Heading/To-Do Item), see |
| smartsheet.* | See Section 5 below | SmartSheet Operations (Worksheet/View/Field/Record), see |
For detailed call examples, please refer to:
references/api_references.md⭐ Important: Document Type Selection Guide
Highly Recommended: SmartCanvas
- New Document: Prioritize using
to create SmartCanvas, for the following reasons:create_smartcanvas_by_markdown
- 📝 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
series tools to perform CRUD operations on existing SmartCanvas, seesmartcanvas.*for detailsreferences/smartcanvas_references.md
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
| Type | doc_type | Recommendation | Description |
|---|---|---|---|
| SmartCanvas | smartcanvas | ⭐⭐⭐ Recommended | Beautiful layout, supports rich components |
| Excel | excel | ⭐⭐⭐ | Specialized for data spreadsheets |
| Slide | slide | ⭐⭐⭐ | Specialized for presentations |
| Mind Map | mind | ⭐⭐⭐ | Specialized for knowledge graphs |
| Flowchart | flowchart | ⭐⭐⭐ | Specialized for process display |
| Word | word | ⭐⭐ | Traditional format with average layout |
| Form | form | ⭐⭐ | Form collection |
| SmartSheet | smartsheet | ⭐⭐⭐ | Advanced structured spreadsheet, supports multi-view and field management |
| Board | board | ⭐⭐ | Online whiteboard |
Tool List
📖 For complete call examples, parameter descriptions and return value explanations of all tools, please refer toreferences/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 theinterface. If a tool does not exist or parameters do not match, please executetools/listfirst to get the latest tool definition.tools/list
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 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.
parent_id📖 For call examples, please refer to:- create_smartcanvas_by_markdownreferences/api_references.md
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 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.
parent_id📖 For call examples, please refer to:- create_excel_by_markdownreferences/api_references.md
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 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.
parent_id📖 For call examples, please refer to:- create_slide_by_markdownreferences/api_references.md
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 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.
parent_id📖 For call examples, please refer to:- create_mind_by_markdownreferences/api_references.md
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 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.
parent_id📖 For call examples, please refer to:- create_flowchart_by_mermaidreferences/api_references.md
create_word_by_markdown
Create Word Document via Markdown. Note: Use only when the user explicitly requires Word format, otherwise use SmartCanvas.
Supports 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.
parent_id📖 For call examples, please refer to:- create_word_by_markdownreferences/api_references.md
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:- query_space_nodereferences/api_references.md
create_space_node
Create a new node in the space, supporting the creation of folders (), online documents (), and links ().
wiki_folderwiki_tdoclink📖 For call examples, please refer to:- create_space_nodereferences/api_references.md
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 useto traverse the node tree.query_space_node
📖 For call examples, please refer to:- search_space_filereferences/api_references.md
delete_space_node
Delete the specified node in the space, supporting two deletion modes.
Deletion Type (remove_type):
- (default): Only delete the current node, child nodes will be automatically mounted to the parent node
current - : Delete the current node and all its child nodes (⚠️ Use with caution, will recursively delete all child nodes)
all
📖 For call examples, please refer to:- delete_space_nodereferences/api_references.md
3. Document Operation Tools
get_content
Get the complete content of the document, pass in to return the document body text.
file_id📖 For call examples, please refer to:- get_contentreferences/api_references.md
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:- batch_update_sheet_rangereferences/api_references.md
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,Taskmust be mounted under aHeadingtype parent node (Pageis required)parent_id - does not need to specify a parent node, it will be inserted into the root node
Page - Parent node does not support type
Heading
📖 For complete description, please refer to:- smartcanvas.create_smartcanvas_elementreferences/smartcanvas_references.md
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:- smartcanvas.get_element_inforeferences/smartcanvas_references.md
smartcanvas.get_page_info
Query all elements in the specified page, supports pagination acquisition. Use the parameter for pagination, indicates that all content has been obtained.
cursoris_over=true📖 For complete description, please refer to:- smartcanvas.get_page_inforeferences/smartcanvas_references.md
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:- smartcanvas.get_top_level_pagesreferences/smartcanvas_references.md
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:- smartcanvas.update_elementreferences/smartcanvas_references.md
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:- smartcanvas.delete_elementreferences/smartcanvas_references.md
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:- smartcanvas.append_insert_smartcanvas_by_markdownreferences/smartcanvas_references.md
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.mdIncludes: 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.mdIncludes: 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 resultEdit 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_elementOrganize Documents into Specified Directory
- Call to find the target folder
query_space_node - Call to create a document node in the target location (prefer smartcanvas as doc_type)
create_space_node
Search and Read Document
- Call to search for documents
search_space_file - Get (i.e.,
node_id) from the resultsfile_id - Call to get the document content
get_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:- Typical Workflow Examplesreferences/smartsheet_references.md
Notes
- Default to use SmartCanvas: Unless the user explicitly specifies another format, prioritize using when creating new documents; use
create_smartcanvas_by_markdownseries tools when editing existing SmartCanvassmartcanvas.* - supported when creating documents: All
parent_idandcreate_*_by_markdowntools support thecreate_flowchart_by_mermaidparameter, which can directly create documents in the specified directory; if not filled, it will be created in the root directoryparent_id - Delete node: only deletes the current node by default (
delete_space_node), usingremove_type=currentwill recursively delete all child nodes, please use with cautionall - 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 to determine if there are more
has_next - is also the
node_idof the documentfile_id - The mermaid content of must be in English entirely
create_flowchart_by_mermaid - SmartCanvas Element Operations: ,
Text,Headingmust be mounted under Page,Taskmust be the ID of a Page type element; callparent_idto get the page structure before operationsmartcanvas.get_top_level_pages - SmartCanvas Pagination Query: uses
smartcanvas.get_page_infofor pagination,cursorindicates that all content has been obtainedis_over=true - SmartCanvas Deletion Note: When deleting a Page element, all its child elements will also be deleted
- SmartSheet Operations: All smartsheet.* tools require and
file_id, callsheet_idto get sheet_id before operationsmartsheet.list_tables - Field type cannot be updated: When using , field_type cannot be modified, but the original value must be passed in
update_fields - Record field value format: The value format varies for different field types, see - Field Value Format Reference for details
references/smartsheet_references.md