mcpserver.so LogoMCPFly
Submit
Yapi MCP Server logo

Yapi MCP Server

by lzsheng

API/Clients & IntegrationYApiAPIIntegrationAutomation

Yapi MCP Server provides tools to interact with a YApi instance. It allows fetching API descriptions from YApi using API IDs.

View on GitHub

Last updated: N/A

What is Yapi MCP Server?

Yapi MCP Server is a tool that provides a server to fetch API descriptions from a YApi instance. It acts as a bridge between other applications and YApi, allowing them to access API information programmatically.

How to use Yapi MCP Server?

  1. Clone the repository.
  2. Create a .env file in the root directory and configure the necessary environment variables (YAPI_TOKEN, YAPI_BASE_URL, PORT).
  3. Install dependencies using pnpm install.
  4. Start the server using pnpm run dev.
  5. Use the available tools, such as get_api_desc, by sending requests to the server with the required parameters.

Key features of Yapi MCP Server

  • Fetches API descriptions from YApi

  • Uses API IDs to identify specific APIs

  • Configurable through environment variables

  • Simple installation and setup

  • Provides a server for easy access

Use cases of Yapi MCP Server

  • Automating API documentation generation

  • Integrating YApi data into other applications

  • Creating custom API workflows

  • Building tools that rely on YApi API descriptions

  • Programmatically access API information

FAQ from Yapi MCP Server

What is YAPI_TOKEN?

YAPI_TOKEN is the access token required to authenticate with your YApi instance.

What is YAPI_BASE_URL?

YAPI_BASE_URL is the base URL of your YApi instance.

What is the purpose of the PORT environment variable?

The PORT environment variable specifies the port number on which the MCP server will listen for incoming requests.

How do I get the apiId?

The apiId is the unique identifier for a specific API endpoint within your YApi project. You can find it in the YApi interface when viewing the API details.

What if I don't have a .env file?

The server will likely fail to start or function correctly without the necessary environment variables defined in the .env file. Make sure to create one and configure it properly.