Yuque

Yuque MCP Server - 语雀MCP服务器，提供与语雀API集成的工具

typescript

3

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You run an MCP server that exposes Yuque content management capabilities through a standardized interface, letting you list repositories, manage documents, and search across your knowledge base with AI tools.

How to use

You interact with the Yuque MCP Server through an MCP client. Start the server locally and point your client to the proper runtime, then call the available tools to get user info, list repos, fetch documents, create or update docs, delete content, or search within repositories.

How to install

Prerequisites: you need Node.js and npm installed on your machine. Ensure you have a working development environment.

Global installation (recommended) and local development are supported. Use the commands below to install and prepare the server.

npm install -g yuque-mcp-server

Alternatively, for a local setup without global installation, run this.

npm install yuque-mcp-server

If you want to build from source and use the local development flow, clone the project, install dependencies, build, and link the package.

git clone https://github.com/tanis2010/yuque-mcp-server.git
cd yuque-mcp-server
npm install
npm run build
npm link

Additional sections

Configuration details and usage notes are covered here to help you run and customize the server securely and effectively.

Available tools

yuque_get_user

Fetch current user information from Yuque.

yuque_get_repos

List knowledge repositories for the authenticated user.

yuque_get_docs

List documents within a repository.

yuque_get_doc

Retrieve details of a specific document.

yuque_create_doc

Create a new document in a repository.

yuque_update_doc

Update an existing document with new content or metadata.

yuque_delete_doc

Delete a document by its ID.

yuque_search_docs

Search documents across a repository or within a specific repository.