Yapi MCP Server

🚀 yapi-mcp-service MCP Server

A TypeScript-based MCP server that implements a simple note-taking system. It demonstrates functionality through the following core MCP concepts.

🚀 Quick Start

This MCP server showcases its features by implementing a simple note-taking system, offering concepts like resources, tools, and prompts.

✨ Features

Resources

• List and access notes using note:// URIs.
• Each note contains a title, content, and metadata.
• Use the plain text MIME type for simple content access.

Tools

• create_note - Create a new text note.
  • Requires passing title and content parameters.
  • Stores the note in the server state.

Prompts

• summarize_notes - Generate a summary of all stored notes.
  • Includes all note content as embedded resources.
  • Returns a structured prompt for LLM summarization.

📦 Installation

Development

Install dependencies:

npm install

Build the server:

npm run build

Development with automatic rebuild:

npm run watch

Integration with Claude Desktop

To use with Claude Desktop, add the server configuration:

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

{
  "mcpServers": {
    "yapi-mcp-service": {
      "command": "/path/to/yapi-mcp-service/build/index.js"
    }
  }
}

Debugging

Since MCP servers communicate via stdio, debugging can be challenging. We recommend using MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in the browser.