Yuque MCP

v1.0.0Knowledge & Memorystable

Enables interaction with Yuque (语雀) knowledge base platform through their API. Supports document management, search, and repository operations including creating, reading, updating, and deleting documents in multiple formats.

mcpyuqueyuque-mcp
Share:
62
Stars
0
Downloads
0
Weekly
0/5

What is Yuque MCP?

Yuque MCP is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to enables interaction with yuque (语雀) knowledge base platform through their api. supports document management, search, and repository operations including creating, reading, updating, and deleting docum...

Enables interaction with Yuque (语雀) knowledge base platform through their API. Supports document management, search, and repository operations including creating, reading, updating, and deleting documents in multiple formats.

This server falls under the Knowledge & Memory category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • Enables interaction with Yuque (语雀) knowledge base platform

Use Cases

Manage documents in Yuque knowledge base through AI.
Create, read, update, and delete documents in multiple formats.
Search and organize knowledge base content automatically.
HenryHaoson

Maintainer

LicenseMIT License
Languagetypescript
Versionv1.0.0
UpdatedMay 19, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx yuque-mcp-server

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Yuque MCP

Yuque MCP Server bridges AI assistants with the Yuque (语雀) knowledge base platform, enabling full document lifecycle management — create, read, update, delete, and search across knowledge bases — through the Yuque API v2. It supports multiple document formats including Markdown, HTML, and Yuque's native Lake format, and handles document privacy settings for private, public, and enterprise-visible content. Teams use it to let Claude draft and publish documentation directly to their Yuque knowledge base, search across repositories, and manage team analytics without leaving their AI workflow.

Prerequisites

  • A Yuque account (yuque.com) with API access enabled
  • A Yuque API token (from Account Settings > Token)
  • Node.js 18 or higher installed
  • An MCP-compatible client such as Claude Desktop
  • Docker (optional, for containerized deployment)
1

Install via Smithery (recommended)

The fastest way to install is through Smithery, which handles configuration automatically for your Claude client.

npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude
2

Obtain your Yuque API token

Log in to yuque.com, go to Account Settings > Token, and create a personal access token. Copy it immediately as it will be needed for all API calls.

3

Clone the repository and configure environment (manual install)

For manual installation, clone the repo and create a .env file with your API credentials.

git clone https://github.com/HenryHaoson/Yuque-MCP-Server
cd Yuque-MCP-Server
npm install
cp .env.example .env
# Edit .env and set YUQUE_API_TOKEN=your_token_here
4

Start the server

Run in development mode with hot reload, or build and start for production use.

# Development:
npm run dev

# Production:
npm run build && npm run start
5

Configure Claude Desktop

Add the Yuque MCP server to your Claude Desktop configuration with your API token as an environment variable.

6

Use document management tools

The server exposes tools including: get_current_user, get_user_repos, get_repo_docs, get_doc, create_doc, update_doc, delete_doc, and search. Team analytics tools include get_group_statistics and get_group_member_statistics.

Yuque MCP Examples

Client configuration

Claude Desktop configuration for the Yuque MCP server with API token and custom base URL for enterprise deployments.

{
  "mcpServers": {
    "yuque-mcp-server": {
      "command": "npx",
      "args": ["yuque-mcp-server"],
      "env": {
        "YUQUE_API_TOKEN": "your_yuque_api_token_here",
        "YUQUE_API_BASE_URL": "https://www.yuque.com/api/v2",
        "PORT": "3000"
      }
    }
  }
}

Prompts to try

Natural language prompts for managing Yuque knowledge base content through Claude.

- "List all my Yuque repositories and their document counts"
- "Create a new Markdown document in my 'Engineering' knowledge base titled 'API Design Guidelines'"
- "Search my Yuque knowledge base for all documents about deployment procedures"
- "Update the 'Onboarding Guide' document to add a section about our new SSO setup"
- "Show me the team statistics for the Engineering group this month"

Troubleshooting Yuque MCP

API calls fail with 401 Unauthorized

Verify that YUQUE_API_TOKEN is set to your personal access token from yuque.com Account Settings > Token. The token must have the required permissions for the operations you are trying to perform. Generate a new token if the existing one has expired.

The server starts but get_user_repos returns an empty list

Confirm your Yuque account has at least one knowledge base (repository) created. The API token must belong to the account that owns the repositories. If using an enterprise Yuque instance, ensure YUQUE_API_BASE_URL points to your enterprise domain rather than the default www.yuque.com.

create_doc fails with a format error

Yuque supports Markdown ('markdown'), HTML ('html'), and Lake ('lake') formats. Specify the correct format parameter when creating documents. For standard content, use 'markdown' as the document type to ensure compatibility across all Yuque clients.

Frequently Asked Questions about Yuque MCP

What is Yuque MCP?

Yuque MCP is a Model Context Protocol (MCP) server that enables interaction with yuque (语雀) knowledge base platform through their api. supports document management, search, and repository operations including creating, reading, updating, and deleting documents in multiple formats. It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Yuque MCP?

Follow the installation instructions on the Yuque MCP GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with Yuque MCP?

Yuque MCP works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Yuque MCP free to use?

Yes, Yuque MCP is open source and available under the MIT License license. You can use it freely in both personal and commercial projects.

Browse More Knowledge & Memory MCP Servers

Explore all knowledge & memory servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "yuque-mcp-server": { "command": "npx", "args": ["-y", "yuque-mcp-server"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide →

Ready to use Yuque MCP?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides