https://github.com/zoeminghong/yapi-mcp-server
Yapi MCP Server
https://github.com/zoeminghong/yapi-mcp-server
mcp yapi
Last synced: 4 months ago
JSON representation
Yapi MCP Server
- Host: GitHub
- URL: https://github.com/zoeminghong/yapi-mcp-server
- Owner: zoeminghong
- License: apache-2.0
- Created: 2025-03-11T14:04:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T14:15:25.000Z (8 months ago)
- Last Synced: 2025-03-24T10:19:44.681Z (8 months ago)
- Topics: mcp, yapi
- Language: JavaScript
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - **yapi-mcp-server** - Yapi MCP Server (Node.js-based) `javascript` `mcp` `yapi` `server` `api` `npm install zoeminghong/yapi-mcp-server` (🌐 Web Development)
README
# yapi-mcp-service MCP Server
A Model Context Protocol server
This is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing:
- Resources representing text notes with URIs and metadata
- Tools for creating new notes
- Prompts for generating summaries of notes
## Features
### Resources
- List and access notes via `note://` URIs
- Each note has a title, content and metadata
- Plain text mime type for simple content access
### Tools
- `create_note` - Create new text notes
- Takes title and content as required parameters
- Stores note in server state
### Prompts
- `summarize_notes` - Generate a summary of all stored notes
- Includes all note contents as embedded resources
- Returns structured prompt for LLM summarization
## Development
Install dependencies:
```bash
npm install
```
Build the server:
```bash
npm run build
```
For development with auto-rebuild:
```bash
npm run watch
```
## Installation
To use with Claude Desktop, add the server config:
On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"yapi-mcp-service": {
"command": "/path/to/yapi-mcp-service/build/index.js"
}
}
}
```
### Debugging
Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
```bash
npm run inspector
```
The Inspector will provide a URL to access debugging tools in your browser.