YApi MCP Server
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@YApi MCP Serverget details for interface ID 789"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
YApi MCP Server
A MCP (Model Context Protocol) server for accessing YApi interface documentation.
Features
📝 Get interface details by ID
🔗 Support YApi URL auto-parsing
Related MCP server: YApi MCP Server
Claude Desktop Configuration
{
"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 URLYAPI_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/23Tool Name
Please use yapi-get-interface tool to get details for interface ID 789License
MIT
Available Tools
2 toolsyapi-get-interfaceB
根据接口ID获取接口详情
| Name | Required | Description | Default |
|---|---|---|---|
| interfaceId | Yes | 接口ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. While '获取' (get) implies a read operation, the description doesn't specify authentication requirements, rate limits, error conditions, response format, or whether this is a safe/idempotent operation. It provides minimal behavioral context beyond the basic action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient Chinese sentence that communicates the core functionality without any wasted words. It's appropriately sized for a simple lookup tool with one parameter and gets straight to the point.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what '接口详情' (interface details) includes in the response, doesn't mention error handling for invalid IDs, and provides minimal behavioral context. Given the lack of structured metadata, the description should do more to compensate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with the single parameter 'interfaceId' documented as '接口ID' (interface ID). The description adds no additional parameter semantics beyond what's already in the schema. The baseline score of 3 is appropriate when the schema provides complete parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('获取' - get/retrieve) and resource ('接口详情' - interface details) with the specific condition '根据接口ID' (based on interface ID). It distinguishes from the sibling tool 'yapi-get-interface-by-url' by specifying ID-based lookup rather than URL-based lookup. However, it doesn't explicitly name the sibling alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage context through '根据接口ID' (based on interface ID), suggesting this tool should be used when you have an interface ID rather than a URL. However, it doesn't explicitly state when to use this vs. the sibling 'yapi-get-interface-by-url' or provide any exclusion criteria or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
yapi-get-interface-by-urlC
根据YApi URL获取接口详情,支持格式如:http://localhost:40001/project/11/interface/api/23
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | YApi接口URL,例如:http://localhost:40001/project/11/interface/api/23 |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It states what the tool does (get interface details from a URL) but doesn't describe behavioral traits like error handling, authentication requirements, rate limits, or what '接口详情' (interface details) includes in the response. For a tool with no annotations, this leaves significant gaps in understanding its operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise and front-loaded: a single sentence stating the purpose followed by a concrete example. Every word earns its place with no redundancy or unnecessary elaboration, making it efficient and easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has no annotations and no output schema, the description is incomplete. It explains what the tool does but lacks crucial context: what '接口详情' (interface details) returns, error conditions, or how it differs from the sibling tool. For a tool with minimal structured data, the description should provide more operational context to be fully helpful.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, with the parameter 'url' fully documented in the schema. The description adds an example URL format ('http://localhost:40001/project/11/interface/api/23'), which provides context but doesn't add significant semantic meaning beyond what the schema already specifies. This meets the baseline score of 3 for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '根据YApi URL获取接口详情' (Get interface details based on YApi URL). It specifies the verb '获取' (get) and resource '接口详情' (interface details), but doesn't distinguish from the sibling tool 'yapi-get-interface' which likely has a different parameter approach. The description provides a concrete example of the URL format, making the purpose specific and actionable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It mentions the sibling tool 'yapi-get-interface' in the context signals, but the description itself doesn't explain the difference (e.g., this tool uses a URL parameter while the sibling might use ID-based parameters). There are no usage prerequisites, exclusions, or comparisons stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
2 tool updates
- First observed
yapi-get-interface - First observed
yapi-get-interface-by-url
TDQS
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.
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.
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.
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
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Turn any task into the right API calls: discover, evaluate, and integrate public APIs.
Versioned documentation registry and semantic search for AI tools and coding assistants.
Discover, compare, and monitor 1,400+ APIs directly from your AI coding agent.
Query any docs site via MCP. Submit a URL, ask questions, get cited answers.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables direct integration with YApi API documentation platform in MCP-compatible editors like Cursor, allowing users to query API details, list interfaces, and search endpoints by simply pasting YApi URLs.517MIT
- AlicenseNot gradedqualityDmaintenanceEnables reading and searching API documentation from YApi instances, allowing AI models to access interface definitions, project API lists, and search through API endpoints using YApi URLs or project IDs.15MIT
- AlicenseNot gradedqualityDmaintenanceEnables interaction with YApi API management platform through natural language, allowing automated interface management including creating/updating APIs, managing categories, importing data, and retrieving project information.299GPL 3.0
- AlicenseAqualityDmaintenanceEnables LLM clients to browse and inspect YAPI API documentation, including project info, categories, interfaces, and full API details with request/response schemas.7151MIT
Appeared in Searches
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/abeixiaolu/yapi-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server