yapi

This is a Model Context Protocol (MCP) server that provides access to YAPI interface details.

Installation

Run this command in your terminal to add the MCP server to Claude Code.

Run in terminal:

Command

claude mcp add --transport stdio devilming-yapi-mcp-server node server.js \
  --env YAPI_TOKEN="Authentication token for YAPI access" \
  --env YAPI_BASE_URL="URL of your YAPI instance (e.g., http://your-yapi-instance.com)" \
  --env YAPI_PROJECT_ID="Target YAPI project ID"

How to use

This MCP server provides a bridge to the YAPI interface details through the MCP (Model Context Protocol) framework. It reads configuration from environment variables and exposes endpoints that allow you to query YAPI project structures, endpoints and related metadata within your MCP-enabled tooling. Once running, you can interact with it via your MCP client or Claude Desktop config to retrieve model context information related to your YAPI project. The server relies on a YAPI instance and a valid project token to fetch and relay the necessary data.

To use it, set up the required environment variables (YAPI_BASE_URL, YAPI_TOKEN, YAPI_PROJECT_ID) and start the server with npm start (as described in the installation guide). In Claude Desktop or your preferred MCP client, point the server entry under mcpServers with the correct URL or socket as configured in your environment. The server will respond with YAPI interface details that can be incorporated into your contextual tools and prompts for more accurate responses and modelling based on your API definitions.

How to install

Prerequisites:

Node.js v14 or higher
npm or yarn
Access to a YAPI instance with a valid project and token

Installation steps:

Clone the repository: git clone https://github.com/your-repo/your-mcp-server.git cd your-mcp-server
Install dependencies: npm install
Create a .env file in the root directory (optional if you provide vars from your environment): YAPI_BASE_URL=http://your-yapi-instance.com YAPI_TOKEN=your-token-here YAPI_PROJECT_ID=your-project-id
Start the server: npm start

Notes:

Ensure your YAPI instance is reachable from the server host.
If you customize the port, update your Claude Desktop config accordingly.

Additional notes

Common issues and tips:

If the server fails to start, verify that YAPI_BASE_URL, YAPI_TOKEN, and YAPI_PROJECT_ID are correctly set and that the YAPI instance accepts the token for the specified project.
Ensure network access from the MCP server to the YAPI instance (firewalls, VPNs, etc.).
The npx/nvim style CLI options are not used here; this server runs via npm start and serves data through MCP-compatible endpoints.
If you need to redeploy, remember to reinstall dependencies and rebuild if you have a bundling step.
For debugging, check the environment log output for missing environment variables or authentication errors.

Related MCP Servers

zen

1.1k

Selfhosted notes app. Single golang binary, notes stored as markdown within SQLite, full-text search, very low resource usage

MCP -Deepseek_R1

A Model Context Protocol (MCP) server implementation connecting Claude Desktop with DeepSeek's language models (R1/V3)

mcp-fhir

A Model Context Protocol implementation for FHIR

mcp

Inkdrop Model Context Protocol Server

mcp-appium-gestures

This is a Model Context Protocol (MCP) server providing resources and tools for Appium mobile gestures using Actions API..

dubco -npm

The (Unofficial) dubco-mcp-server enables AI assistants to manage Dub.co short links via the Model Context Protocol. It provides three MCP tools: create_link for generating new short URLs, update_link for modifying existing links, and delete_link for removing short links.