YuQue MCP
YuQue MCP acts as a smart bridge that allows AI assistants to interact directly with the YuQue knowledge base. In simple terms, it means an AI can "reach into" a user's digital notebook to read existing articles, search for specific information, or even write down new ideas on its own. …
About this Protocol
How to Use
1. Installation
This MCP server is built using Go. To install and run it locally, follow these steps:
- Set Environment Variable:
bash export YUQUE_TOKEN="your_yuque_token_here" - Install Dependencies:
Navigate to the project directory and run:
bash go mod tidy - Start the Server:
bash go run cmd/server/main.go -f config.yaml
The server will start athttp://localhost:8080.
2. Configuration
To integrate this server with Cursor IDE or other MCP-compatible clients, use the following JSON configuration:
{
"mcpServers": {
"yuque": {
"command": "go",
"args": ["run", "cmd/server/main.go", "-f", "config.yaml"],
"cwd": "/path/to/YuQueMCP",
"env": {
"YUQUE_TOKEN": "your_yuque_token_here"
}
}
}
}
Configuration Steps:
1. Open your IDE's MCP settings.
2. Add the JSON block above.
3. Important: Replace /path/to/YuQueMCP with the actual absolute path to the project on your machine.
4. Important: Replace your_yuque_token_here with your actual YuQue API Token.
5. Restart the application to apply changes.
3. Available Tools
The YuQue MCP server provides the following tools for interacting with the knowledge base:
yuque_get_current_user: Retrieves detailed information about the currently authenticated user.yuque_get_document: Retrieves the content of a specific document.book_id: Knowledge base ID or path.doc_id: Document ID or slug.
yuque_create_document: Creates a new document in a specified knowledge base.book_id: Knowledge base ID or path.title: Document title.body: Document content (Markdown).format: Document format (defaults to markdown).public: Privacy setting (0 for private).
yuque_update_document: Updates an existing document's title or content.book_id,doc_id: Identifiers for the document.title,body,format,public: Optional fields to update.
yuque_search_documents: Searches for documents across the YuQue platform.query: The search keyword.
4. Example Prompts
No specific example prompts were provided in the source content.
Use Cases
Use Case 1: Streamlined Technical Documentation Sync
Problem: Developers often update code and logic within their IDE but forget to manually update the corresponding documentation in the company’s YuQue knowledge base, leading to outdated and misleading documentation.
Solution: By using the YuQue MCP within an IDE like Cursor, developers can ask the AI to bridge the gap. The AI can analyze the recent code changes and use yuque_update_document to synchronize the documentation immediately without the developer leaving their workspace.
Example: A developer finishes a new API endpoint and tells the AI: "Update the 'API Reference' document in the Backend knowledge base to include the new /v2/auth parameters I just wrote." The AI reads the code, fetches the current doc via yuque_get_document, and pushes the update.
Use Case 2: AI-Powered Internal Support Assistant
Problem: Large organizations have massive YuQue knowledge bases, making it difficult for employees to find specific answers (e.g., "What is the policy for remote work equipment?") without manually clicking through dozens of folders.
Solution: This MCP allows an AI assistant to act as a "smart librarian." Using yuque_search_documents and yuque_get_document, the AI can search through the entire knowledge base, read multiple relevant pages, and provide a direct, summarized answer to the user.
Example: A new hire asks: "How do I configure my local environment for the payment service?" The AI searches YuQue, finds the 'Onboarding' and 'Payment Service' docs, synthesizes the steps, and presents a concise checklist to the user.
Use Case 3: Automated Research and Knowledge Synthesis
Problem: Researching a topic involves finding multiple related documents, extracting the key points, and creating a new summary report, which is a time-consuming manual process of copying and pasting.
Solution: The AI can automate the synthesis process. It can use yuque_search_documents to find all docs related to a topic, read them using yuque_get_document, and then use yuque_create_document to generate a high-level summary or "Table of Contents" in a specified knowledge base.
Example: A product manager says: "Find all documents related to the 'Q4 User Feedback' sessions, summarize the top 3 recurring complaints, and create a new document titled 'Q4 Feedback Summary' in the Product Roadmap book."
Use Case 4: Collaborative Bug Resolution Documentation
Problem: When a team solves a complex bug, the solution is often buried in Slack or Jira, and it is rarely documented in the permanent YuQue wiki for future reference.
Solution: Immediately after a bug is resolved in the IDE, the developer can use the AI to capture the context. The AI can summarize the fix and use yuque_create_document to save it into a "Troubleshooting" or "Lessons Learned" folder in YuQue.
Example: After fixing a memory leak, the developer tells the AI: "Summarize this fix and the root cause, then add it as a new document in the 'Known Issues' knowledge base so the team can reference it if this happens again."