Server Yuque.git

Yuque API MCP Server

An MCP (Model Context Protocol) server for Yuque APIs, enabling large language models to interact with Yuque API seamlessly.

中文文档

Features

This server provides the following tools for interacting with Yuque API:

User Management

• hello - Check if Yuque API connection is working properly
• get-current-user - Get detailed information of the current authorized user

Search

• search - Search for documents, knowledge bases, users, or teams

Team (Group) Management

• get-user-groups - Get list of teams a user has joined
• get-group-users - Get list of members in a team
• update-group-user - Update a team member's role
• delete-group-user - Remove a member from a team
• get-group-stats - Get statistics of a team
• get-group-repos - Get list of knowledge bases created by a team

Repository (Knowledge Base) Management

• get-user-repos - Get list of knowledge bases created by a user
• create-repo - Create a new knowledge base
• update-repo - Update knowledge base information
• delete-repo - Delete a knowledge base
• get-repo-detail - Get detailed information about a knowledge base

Document Management

• get-book-docs-list - Get document list of a knowledge base
• get-book-doc-detail - Get detailed information of a document in a knowledge base
• create-book-doc - Create a new document in a knowledge base
• update-book-doc - Update a document in a knowledge base
• delete-book-doc - Delete a document from a knowledge base
• get-group-docs-list - Get document list of a team knowledge base
• get-group-doc-detail - Get detailed information of a document in a team knowledge base
• create-group-doc - Create a new document in a team knowledge base
• update-group-doc - Update a document in a team knowledge base
• delete-group-doc - Delete a document from a team knowledge base
• get-doc-versions - Get document version history
• get-doc-version-detail - Get document version details

Table of Contents (TOC) Management

• get-book-toc - Get table of contents (TOC) for a knowledge base
• update-book-toc - Update table of contents (TOC) for a knowledge base
• get-group-book-toc - Get table of contents (TOC) for a team knowledge base
• update-group-book-toc - Update table of contents (TOC) for a team knowledge base

Installation and Usage

Prerequisites

• Node.js 16.x or higher
• Yuque API Token

Installation

# Install dependencies
pnpm install

# Build the project
pnpm build

Configuration

Set the YUQUE_API_TOKEN environment variable to authorize access to the Yuque API:

export YUQUE_API_TOKEN="your-api-token-here"

Running

# Start the server
pnpm start

Using in VS Code

This project is configured to be recognized by the VS Code MCP plugin. If you have the VS Code MCP plugin installed, you can use this server directly in VS Code:

1. Select MCP as "server-yuque"
2. Enter your Yuque API Token
3. Start using Yuque MCP Server in VS Code

{
  "servers": {
    "yuque-api": {
      "type": "stdio",
      "command": "node",
      "args": ["server-yuque"],
      "env": {
        "YUQUE_API_TOKEN": "YOUR_YUQUE_API_TOKEN"
      }
    }
  }
}

How to Get a Yuque API Token

1. Log in to the Yuque website (www.yuque.com)
2. Go to your personal settings page
3. Click on "Developer Settings"
4. Create a new API Token

License

MIT