Yuque MCP Server
by HenryHaoson
A Model-Context-Protocol (MCP) server for integrating with the Yuque API. It allows AI models to interact with Yuque knowledge base platform.
Last updated: N/A
What is Yuque MCP Server?
The Yuque MCP Server is a tool that enables AI models to interact with the Yuque knowledge base platform through a Model-Context-Protocol interface. It provides a set of tools for managing users, documents, and knowledge bases within Yuque, as well as retrieving statistics and performing searches.
How to use Yuque MCP Server?
To use the server, you need to clone the repository, install the dependencies, configure your Yuque API token, and then run the server in either development or production mode. You can also deploy it using Docker. Once the server is running, AI models can connect to it and use the registered tools to interact with Yuque data.
Key features of Yuque MCP Server
User and document management (CRUD operations)
Knowledge base management
Search functionality
Team statistics and analytics
Docker support for easy deployment
Use cases of Yuque MCP Server
Automated document creation and management
AI-powered knowledge base search
Integration with AI models for content generation and summarization
Team knowledge base analytics and reporting
FAQ from Yuque MCP Server
How do I configure the Yuque API token?
How do I configure the Yuque API token?
You can set the YUQUE_API_TOKEN environment variable in the .env file or pass it as a query parameter when connecting to the SSE endpoint.
What document formats are supported?
What document formats are supported?
The server supports Markdown, HTML, and Lake document formats.
Can I deploy the server using Docker?
Can I deploy the server using Docker?
Yes, the project provides Docker support with both Docker Compose and manual Docker commands.
How do I add a new tool to the server?
How do I add a new tool to the server?
You can modify the registerTools method in src/server.ts.
What is the purpose of the CLI mode?
What is the purpose of the CLI mode?
The CLI mode allows you to interact with the Yuque API directly from the command line using the same tools exposed by the server.