Henryhaoson Yuque MCP Server

🚀 Yuque Model-Context-Protocol (MCP) Server

This project is an implementation of an MCP server for interacting with Yuque knowledge bases. It enables AI models to connect to the server via the Model-Context-Protocol and interact with the data and features of the Yuque platform using registered tools.

The MCP protocol is a standardized protocol that defines the interface between AI models and external tools or services. Through this project, AI models can perform various operations, including querying, creating, updating, and deleting documents, as well as retrieving team statistics.

🚀 Quick Start

Prerequisites

• Node.js (version 18.0.0 or higher)
• npm (version 8.0.0 or higher)

Clone the Repository

git clone https://github.com/yourusername/yuque-mcp-server.git

Install Dependencies

npm install

Configuration

Environment Variables

Copy the config.example.ts file to the project root directory and rename it to config.ts. Modify the configuration parameters according to your needs.

// config.ts
export const config = {
  port: 3000, // Server port
  baseUrl: 'https://api.yuque.com', // Yuque API base URL
  accessToken: 'your_api_token_here' // Yuque API access token
};

Additional Configuration

You can further adjust the server behavior in src/server.ts as needed.

Start the Server

npm run dev

Or in a production environment:

npm start

✨ Features

Connect to the SSE Endpoint

You can connect to the server's SSE (Server-Sent Events) endpoint via the following URL:

const eventSource = new EventSource(`http://localhost:${config.port}/sse`);

Query Parameter Override

When connecting to the SSE endpoint, you can override the configuration in the environment variables via query parameters:

// Example URL:
// http://localhost:3000/sse?accessToken=your_token_here&baseUrl=https://custom.yuque.api/v2

Integration with AI Models

1. Start the MCP server.
2. Connect to the server using a compatible client.
3. The AI model can now interact with the Yuque knowledge base using the registered tools.

Development

Project Structure

src/
├── config.ts          # Server configuration
├── index.ts           # Main entry point
├── cli.ts             # CLI entry point 
├── server.ts          # MCP server implementation
└── services/
    └── yuque.ts       # Yuque API service

Add New Tools

To add new tools, use the registerTools method in src/server.ts.

Recent Updates

New Features

1. Team Statistics: Added the ability to retrieve statistics for teams, members, knowledge bases, and documents.
2. Enhanced Document Management:
   • Supports multiple document formats (Markdown, HTML, Lake).
   • Complete document publicity settings (private, public, publicly available within the enterprise).
3. Improved Search Functionality: Supports more parameters and filtering conditions.

Data Type Refinement

Updated the interface definitions to align with the Yuque OpenAPI specification.

📄 License

ISC