yuque-mcp-server: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Yuque MCP Server is a Model Context Protocol (MCP) server that provides integration with Yuque (语雀), a popular Chinese documentation platform. It enables AI assistants to manage Yuque documents, repositories, and search functionality through a standardized MCP interface.

Claude Code Integration

Loading This Server in Claude Code

The easiest way to configure this MCP server is using the Claude Code CLI:

🚀 Quick Setup (Recommended)

# Install the package globally first
npm install -g yuque-mcp-server

# Add to Claude Code with automatic configuration
claude mcp add -s local yuque yuque-mcp-server --env YUQUE_TOKEN=your_yuque_api_token_here

The claude mcp add command automatically:

• Configures the MCP server in your Claude Code settings
• Handles environment variables securely
• Sets up the proper command structure

Manual Configuration (Alternative)

If you prefer manual setup, edit ~/.claude/settings.json:

{
  "mcpServers": {
    "yuque": {
      "command": "yuque-mcp-server",
      "env": {
        "YUQUE_TOKEN": "your_yuque_api_token_here"
      }
    }
  }
}

Local Development Setup

For development from this repository:

{
  "mcpServers": {
    "yuque": {
      "command": "node",
      "args": ["path/to/this/project/dist/server.js"],
      "env": {
        "YUQUE_TOKEN": "your_yuque_api_token_here"
      }
    }
  }
}

Important: After configuration, restart Claude Code to load the server.

Available Tools

Once loaded, this server provides these MCP tools:

• yuque_get_user - Get current user information
• yuque_get_repos - List knowledge repositories
• yuque_get_docs - List documents in a repository
• yuque_get_doc - Get document details
• yuque_create_doc - Create new document
• yuque_update_doc - Update existing document
• yuque_delete_doc - Delete document
• yuque_search_docs - Search documents