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. Instead of manually copying and pasting text between a chat window and a documentation site, this tool gives the AI the ability to manage those notes automatically. Under the hood, this server provides a suite of specialized tools for document management and retrieval. It can fetch full document details using specific IDs, perform comprehensive keyword searches, and update existing content including titles and body text. Because it supports Markdown by default, it ensures that any content the AI creates or modifies stays perfectly formatted and consistent with the platform's professional standards. For developers and teams using LLMs, this MCP is a powerful way to turn static internal wikis into living data sources. Built with the go-zero framework, it integrates easily into environments like the Cursor IDE, allowing an AI assistant to have programmatic access to project specs and organizational knowledge. This setup enables high-level automation, such as allowing an AI to document code changes in real-time or help developers find technical answers hidden deep within their company’s private documentation.
Category: Files, Documents & PDFs
Tags: documentation, knowledge-base, markdown, wiki, yuque
bash export YUQUE_TOKEN="your_yuque_token_here" 2. Install Dependencies: Navigate to the project directory and run: bash go mod tidy 3. Start the Server: bash go run cmd/server/main.go -f config.yaml The server will start at http://localhost:8080. ---json { "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. ---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. ---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/authparameters I just wrote." The AI reads the code, fetches the current doc viayuque_get_document`, and pushes the update.
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.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."Part of MCP Servers
YuQue MCP requires Go. Clone the repository, export your YuQue token using the YUQUE_TOKEN environment variable, run go mod tidy to install dependencies, and register the server command in your client configuration file like Cursor IDE settings before restarting.
The server provides tools to interact with the YuQue API. It allows AI models to fetch authenticated user details, retrieve specific documents by book and document IDs, create new Markdown documents, update document titles and bodies, and execute platform searches.
YuQue MCP works with any client that implements the Model Context Protocol, including Cursor IDE. Configuration examples provided in the repository use the standard JSON format specifying the Go runtime command, configuration flags, and required environment variables.
Yes, YuQue MCP is an open-source project hosted on GitHub under the repository ArianChen777/YuQueMCP. Users can inspect the Go codebase, adapt the go-zero MCP server logic, and customize the YAML configuration.