Overview
What is mcp-server-yuque?
mcp-server-yuque is a TypeScript-based MCP server that implements a simple notes system. It records notes to yuque and demonstrates core MCP concepts through resources, tools, and prompts. It is intended for users who want to manage text notes via the Model Context Protocol, potentially integrating with the Yuque knowledge base platform.
How to use mcp-server-yuque?
Install dependencies with npm install, build the server with npm run build, then configure Claude Desktop by adding the server’s built index.js path to the mcpServers section of its configuration file. Run the MCP Inspector with npm run inspector for debugging.
Key features of mcp-server-yuque
- Resources: text notes accessible via
note://URIs with title, content, and metadata - Tools:
create_noteto create new notes with title and content - Prompts:
summarize_notesgenerates a structured summary of all notes - Built in TypeScript and follows the MCP specification
Use cases of mcp-server-yuque
- Create and store text notes programmatically via an MCP client
- List and retrieve notes by their URI for reading or processing
- Generate an LLM-friendly summary of all stored notes
- Integrate note-taking capabilities into an MCP-powered assistant
FAQ from mcp-server-yuque
What resources does mcp-server-yuque provide?
It provides text notes accessible via note:// URIs. Each note has a title, content, and metadata, served with plain text MIME type.
What tools does mcp-server-yuque offer?
It offers the create_note tool, which takes title and content as required parameters and stores the note in the server’s state.
How to install mcp-server-yuque with Claude Desktop?
Add the server configuration to the Claude Desktop config file (claude_desktop_config.json), setting the command to the full path of the built index.js file.
What prompts does mcp-server-yuque include?
It includes the summarize_notes prompt, which returns a structured prompt that includes all stored notes as embedded resources for LLM summarization.
How to debug mcp-server-yuque?
Use the MCP Inspector by running npm run inspector. It provides a URL to access debugging tools in your browser.