yapi-mcp-service logo

yapi-mcp-service

by zoeminghong

yapi-mcp-service is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing resources, tools, and prompts related to managing text notes.

View on GitHub

Last updated: N/A

What is yapi-mcp-service?

yapi-mcp-service is a Model Context Protocol (MCP) server built with TypeScript. It provides a simple notes system to demonstrate MCP concepts, allowing users to create, access, and summarize text notes.

How to use yapi-mcp-service?

To use, install dependencies with npm install, build the server with npm run build, and then add the server configuration to your Claude Desktop configuration file (claude_desktop_config.json). The configuration specifies the command to run the built server. You can then interact with the server through Claude Desktop using the provided resources, tools, and prompts. Debugging can be done using the MCP Inspector.

Key features of yapi-mcp-service

  • Resources: List and access notes via note:// URIs with title, content, and metadata

  • Tools: create_note tool for creating new text notes with title and content parameters

  • Prompts: summarize_notes prompt to generate a summary of all stored notes, including note contents as embedded resources

  • Plain text mime type for simple content access

Use cases of yapi-mcp-service

  • Demonstrating MCP server implementation

  • Creating and managing simple text notes within an MCP environment

  • Generating summaries of notes using LLMs via prompts

  • Integrating with Claude Desktop for note management

FAQ from yapi-mcp-service

What is MCP?

Model Context Protocol (MCP) is a protocol for providing context to language models.

How do I install the server?

Install dependencies with npm install, build the server with npm run build, and configure Claude Desktop.

Where is the Claude Desktop configuration file?

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json. On Windows: %APPDATA%/Claude/claude_desktop_config.json

How do I debug the server?

Use the MCP Inspector with npm run inspector.

What is the create_note tool?

It's a tool for creating new text notes, requiring title and content as parameters.