Skip to main content
Glama
abeixiaolu

YApi MCP Server

by abeixiaolu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote
README.md
# YApi MCP Server

[![English](https://img.shields.io/badge/lang-English-blue.svg)](./README.md)
[![中文](https://img.shields.io/badge/语言-中文-red.svg)](./README.ZH.md)

A MCP (Model Context Protocol) server for accessing YApi interface documentation.

## Features

- 📝 Get interface details by ID
- 🔗 Support YApi URL auto-parsing

## Claude Desktop Configuration

```json
{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-server@latest"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "your-yapi-token"
      }
    }
  }
}
```

## Environment Variables

- `YAPI_BASE_URL`: Your YApi server URL
- `YAPI_TOKEN`: YApi access token

### How to Get Token

Login to YApi → Profile Settings → Copy Token

## Usage

### Direct URL

```
Please get the information for this interface: http://localhost:40001/project/11/interface/api/23
```

### Tool Name

```
Please use yapi-get-interface tool to get details for interface ID 789
```

## License

MIT
Deploy Server
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

B3.1/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have clearly distinct purposes: one retrieves interface details by ID, while the other retrieves them by URL. There is no overlap or ambiguity between their functions, making it easy for an agent to select the correct tool based on the available input.

Naming Consistency5/5

Both tools follow a consistent naming pattern: 'yapi-get-interface' with a suffix indicating the input type ('-by-url'). This verb_noun structure is uniform and predictable, enhancing readability and usability across the tool set.

Tool Count2/5

With only 2 tools, the server feels under-scoped for a YApi (API management) domain. This minimal set lacks essential operations like creating, updating, or listing interfaces, which are typical for such systems, making it insufficient for comprehensive agent workflows.

Completeness2/5

The tool surface is severely incomplete for API management. It only provides retrieval methods (by ID and URL), missing critical CRUD operations such as create, update, delete, or list interfaces. This creates significant gaps that will likely cause agent failures in handling full lifecycle tasks.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources