yuque-document-management

Original：🇨🇳 Chinese
Translated

Manage YuQue knowledge base documents via the YuQue MCP tool. Suitable for creating, searching, updating, moving or deleting YuQue documents; organizing knowledge base structure; batch document operations; managing document templates; and implementing collaborative workflows. Provides MCP tool integration modes and key usage points.

5installs
Sourcedoomclouds/lightragnet
Added on

NPX Install

npx skill4agent add doomclouds/lightragnet yuque-document-management

Tags

Translated version includes tags in frontmatter
yuque-mcp-tooldocument-managementknowledge-baseworkflow-automationerror-handling

SKILL.md Content (Chinese)

View Translation Comparison →

YuQue Document Management

Manage YuQue knowledge base documents via the YuQue MCP tool. This skill focuses on the key usage points and common operation modes of the MCP tool.

MCP Tool Overview

All operations are performed via the YuQue MCP tool:
  • mcp_YuQueMCP_get_default_repository
    - Get default knowledge base information
  • mcp_YuQueMCP_get_repository_toc_tree
    - Get complete directory tree structure
  • mcp_YuQueMCP_search
    - Search documents
  • mcp_YuQueMCP_create_document
    - Create new documents
  • mcp_YuQueMCP_get_document
    - Read document content
  • mcp_YuQueMCP_update_document
    - Update document content or title
  • mcp_YuQueMCP_move_document
    - Move documents to other directories
  • mcp_YuQueMCP_delete_document
    - Delete documents

Basic Operation Points

Create Document

Steps:
  1. Get directory structure: Use 
    mcp_YuQueMCP_get_repository_toc_tree
    to understand the organization
  2. Determine location: Select an appropriate 
    parentUuid
    or use the root directory (null)
  3. Prepare content: Use Markdown format
  4. Create document: Call 
    mcp_YuQueMCP_create_document
    with parameters: 
    • title
      (required): Document title
    • body
      (optional): Document content in Markdown format
    • parentUuid
      (optional): Parent directory UUID
Key Points:
  • Titles must be unique in the same directory
  • Use standard Markdown syntax for content
  • If 
    parentUuid
    is not specified, the document will be created in the root directory

Search Documents

Usage:
mcp_YuQueMCP_search query="search keywords" type="DOC" page=1
Parameter Description:
  • query
    (required): Search keywords
  • type
    (optional): Document type filter
  • page
    (optional): Pagination page number
Key Points:
  • Use specific keywords instead of general terms
  • Combine multiple keywords to improve accuracy
  • Use pagination for large result sets

Update Document

Usage:
mcp_YuQueMCP_update_document docId="document ID" body="new content" title="new title"
Parameter Description:
  • docId
    (required): Document ID
  • body
    (optional): New document content
  • title
    (optional): New document title
Key Points:
  • Provide at least either 
    body
    or 
    title
  • Verify that changes take effect after update
  • Confirm the document ID is correct

Move Document

Usage:
mcp_YuQueMCP_move_document docId="document ID" parentUuid="target parent directory UUID"
Key Points:
  • If 
    parentUuid
    is null, move to the root directory
  • Confirm the target directory exists
  • Avoid circular references (cannot move to its own subdirectory)

Delete Document

Usage:
mcp_YuQueMCP_delete_document docId="document ID"
Key Points:
  • Deletion is irreversible, confirm before proceeding
  • Verify the document ID is correct
  • Backup content before deletion if needed

Common Workflows

Document Creation Workflow

  1. View Structure: Use 
    get_repository_toc_tree
    to understand existing organization
  2. Determine Location: Select appropriate parent directory UUID
  3. Prepare Content: Write content in Markdown format
  4. Create Document: Call 
    create_document
  5. Verify Result: Confirm the document appears in the expected location

Document Organization Workflow

  1. Get Current Structure: Use 
    get_repository_toc_tree
    to view the complete directory tree
  2. Identify Documents to Move: Determine restructuring goals
  3. Execute Move: Use 
    move_document
    to reposition
  4. Verify Structure: Re-fetch the directory tree after moving to confirm

Error Handling Key Points

Common Errors

Document Creation Failed:
  • Check if the title is unique in the target directory
  • Verify Markdown syntax is correct
  • Confirm 
    parentUuid
    exists
No Search Results:
  • Try broader or alternative keywords
  • Check spelling and terminology
  • Verify document visibility/permissions
Move Failed:
  • Confirm the target 
    parentUuid
    exists
  • Check if the source document exists
  • Verify no circular references

Error Handling Mode

python
try:
    result = mcp_YuQueMCP_create_document(title="Title", body="Content")
except Exception as e:
    # Log error
    # Implement retry logic
    # Provide user feedback

Usage Best Practices

Pre-Operation Preparation

  1. Get Knowledge Base Information: First call 
    get_default_repository
    to understand the knowledge base
  2. View Directory Structure: Use 
    get_repository_toc_tree
    to plan organization
  3. Search Verification: Search to confirm the document does not exist before creation

Content Specifications

  • Use clear, descriptive titles
  • Use standard Markdown format for content
  • Keep document size moderate (avoid oversized 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

ToolRequired ParametersOptional ParametersDescription
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 Documents

For detailed information, refer to:
  • references/mcp-tools.md - Complete MCP tool reference
  • references/troubleshooting.md - Troubleshooting guide