YApi

Go-based MCP server that reads YApi project interfaces and exposes them to large language models.

javascript

0

GitHub Stars

javascript

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "ko-good-code-yapi-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@neigri/yapi-mcp-server@latest"
      ],
      "env": {
        "YAPI_TOKEN": "your-token-optional",
        "YAPI_BASE_URL": "http://your-yapi-instance.com"
      }
    }
  }
}

You are using a Go-based MCP server that reads interfaces from YApi and exposes them to large language models. It supports running locally via Go tooling or quickly via npm/npx, making it easy to fetch single interfaces or whole projects for AI workflows.

How to use

To access YApi data from your MCP client, you can run the server locally and point your client at it, or use the published MCP endpoint if you have one. This MCP provides tools to fetch a single YApi interface or an entire project interface list, enabling you to feed the data into AI prompts or autonomous agents.

How to install

Prerequisites you need before installation:

Node.js and npm or npx (for quick start)
Go toolchain (for local build)

Option 1: Run via npx (recommended)

npx -y @neigri/yapi-mcp-server@latest

Option 2: Build and run locally from source

# Install Go dependencies
go mod download

# Build the project
make build
# or
go build -o bin/yapi-mcp-server .

# Run the server
./bin/yapi-mcp-server

Configuration and usage notes

Environment variables control how the server connects to YApi. You can set them in your shell or in a runtime environment when launching the MCP.

Example MCP config (local stdio usage)

{
  "type": "stdio",
  "name": "yapi_mcp",
  "command": "npx",
  "args": ["-y", "@neigri/yapi-mcp-server@latest"],
  "env": {
    "YAPI_BASE_URL": "http://your-yapi-instance.com",
    "YAPI_TOKEN": "your-token-optional"
  }
}