Overview
What is yapi-mcp-server?
yapi-mcp-server is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing resources for accessing notes, a tool for creating new notes, and prompts for generating summaries.
How to use yapi-mcp-server?
Install dependencies with npm install, build with npm run build, and configure the server in your MCP client (e.g., Claude Desktop) by adding the server’s build path to claude_desktop_config.json. Use the create_note tool with title and content parameters to create notes, and the summarize_notes prompt to generate a summary of all stored notes.
Key features of yapi-mcp-server
- List and access notes via
note://URIs with metadata. - Create new text notes using the
create_notetool. - Generate structured summaries of all notes via the
summarize_notesprompt. - Built with TypeScript for reliable MCP integration.
Use cases of yapi-mcp-server
- Storing and retrieving simple text notes through MCP.
- Demonstrating how to implement resources, tools, and prompts in an MCP server.
- Providing a reference for developers building MCP-based note-taking applications.
FAQ from yapi-mcp-server
What does the server do?
It manages a collection of text notes with titles and metadata, allowing an LLM to create, read, and summarize notes via MCP.
What are the dependencies and runtime requirements?
The server requires Node.js and npm. Dependencies are installed via npm install and the server is built with npm run build.
Where are the notes stored?
Notes are stored in server state (in memory) and are not persisted across sessions.
What transport does it use?
The server communicates over stdio, as is standard for MCP servers.
How can I debug the server?
Use the built-in MCP Inspector by running npm run inspector, which provides a URL for debugging tools in a browser.