yuque-document-management

YuQue Document Management

Manage YuQue knowledge base documents through YuQue MCP tools. This skill focuses on key usage points and common operation patterns of MCP tools.

MCP Tool Overview

All operations are completed through YuQue MCP tools:

• mcp_YuQueMCP_get_default_repository - Get default knowledge base information
• mcp_YuQueMCP_get_repository_toc_tree - Get the complete directory tree structure
• mcp_YuQueMCP_search - Search documents
• mcp_YuQueMCP_create_document - Create a new document
• mcp_YuQueMCP_get_document - Read document content
• mcp_YuQueMCP_update_document - Update document content or title
• mcp_YuQueMCP_move_document - Move a document to another directory
• mcp_YuQueMCP_delete_document - Delete a document

Basic Operation Key Points

Create Document

Steps:

1. Get the directory structure:mcp_YuQueMCP_get_repository_toc_tree understand the organization method
2. Determine the location: choose an appropriate parentUuid or use the root directory (null)
3. Prepare content: use Markdown format
4. Create the document: call mcp_YuQueMCP_create_document, parameters:
   • title(required): document title
   • body(optional): document content in Markdown format
   • parentUuid(optional): parent directory UUID

Key points:

• Titles must be unique under the same directory
• Content uses standard Markdown syntax
• If parentUuid is not specified, it is created in the root directory

Search Documents

Usage:

mcp_YuQueMCP_search query="搜索关键词" type="DOC" page=1

Parameter description:

• query(required): search keyword
• type(optional): document type filter
• page(optional): pagination page number

Key points:

• Use specific keywords rather than generic terms
• Combine multiple keywords to improve precision
• Use pagination for large result sets

Update Document

Usage:

mcp_YuQueMCP_update_document docId="文档ID" body="新内容" title="新标题"

Parameter description:

• docId(required): document ID
• body(optional): new document content
• title(optional): new document title

Key points:

• Provide at least one of body or title
• After updating, verify whether the changes took effect
• Confirm that the document ID is correct

Move Document

Usage:

mcp_YuQueMCP_move_document docId="文档ID" parentUuid="目标父目录UUID"

Key points:

• If parentUuid is null, move to the root directory
• Confirm that the target directory exists
• Avoid circular references (cannot move to its own subdirectory)

Delete Document

Usage:

mcp_YuQueMCP_delete_document docId="文档ID"

Key points:

• The delete operation is irreversible and requires confirmation
• Verify that the document ID is correct
• Back up the content before deleting

Common Workflows

Document Creation Process

1. View structure：get_repository_toc_tree understand the existing organization
2. Determine location: choose an appropriate parent directory UUID
3. Prepare content: write content in Markdown format
4. Create document: call create_document
5. Verify result: confirm that the document appears in the expected location

Document Organization Process

1. Get the current structure：get_repository_toc_tree View the complete directory tree
2. Identify documents that need to be moved: Determine the reorganization target
3. Perform the move: Use move_document to reposition
4. Verify the structure: After moving, retrieve the directory tree again to confirm

Error Handling Key Points

Common Errors

Document creation failed:

• Check whether the title is unique in the target directory
• Verify that the Markdown syntax is correct
• Confirm that the parentUuid exists

Search returned no results:

• Try broader or alternative keywords
• Check spelling and terminology
• Verify document visibility/permissions

Move failed:

• Confirm that the target parentUuid exists
• Check whether the source document exists
• Verify that there are no circular references

Error Handling Patterns

try:
    result = mcp_YuQueMCP_create_document(title="标题", body="内容")
except Exception as e:
    # 记录错误
    # 实现重试逻辑
    # 提供用户反馈

Best Practices to Use

Preparation Before Operations

1. Get knowledge base information: First call get_default_repository to learn about the knowledge base
2. View the directory structure: Use get_repository_toc_tree to plan the organization
3. Search verification: Search before creating to confirm the document does not exist

Content Guidelines

• Use clear, descriptive titles
• Use standard Markdown format for content
• Keep documents moderately sized (avoid overly large documents)
• Organize related documents in the same directory

Collaboration Notes

• Set appropriate visibility permissions
• Use version naming for major changes
• Coordinate with the team before moving documents
• Regularly clean up outdated content

Tool Parameter Quick Reference

Tool	Required Parameters	Optional Parameters	Description
create_document	title	body, parentUuid	Create document
get_document	docId	-	Read document
update_document	docId	body, title	Update document
move_document	docId	parentUuid	Move document
delete_document	docId	-	Delete document
search	query	type, page	Search documents
get_repository_toc_tree	-	-	Get directory tree
get_default_repository	-	-	Get knowledge base information

Reference Documentation

For detailed information, see:

• references/mcp-tools.md - Complete MCP tool reference
• references/troubleshooting.md - Troubleshooting guide