Yapi

Servidor MCP Yapi

Recomendado: Se você só precisa pesquisar interfaces Yapi ou obter detalhes de interfaces, use primeiro o leve Yapi Skill. Ele chama o Yapi por meio de scripts Python locais e não requer iniciar o servidor MCP Java/Docker. Use este projeto quando precisar de uma integração completa com servidor MCP.

Um servidor Model Context Protocol (MCP) para a plataforma de gerenciamento de API Yapi. Este projeto fornece integração perfeita entre assistentes de IA e o Yapi, permitindo consultar documentação de API, pesquisar interfaces e gerenciar informações de API por meio de linguagem natural.

Para a versão em chinês deste documento, consulte README_zh.md.

Recursos

Este servidor MCP fornece as seguintes ferramentas para interagir com o Yapi:

Ferramenta	Descrição
listProjects	Listar todos os projetos Yapi configurados com seus IDs e nomes
listCategories	Obter categorias de interface para um projeto Yapi específico
listCatInterfaces	Listar interfaces dentro de uma categoria específica
searchInterfaces	Pesquisar interfaces de API por nome de projeto, palavra-chave ou caminho
getInterfaceDetail	Obter informações detalhadas sobre uma interface de API específica
refreshCache	Atualizar manualmente o cache do Yapi
clearProjectCache	Limpar o cache de um projeto específico
getCacheStats	Obter estatísticas de informações do cache

Pré-requisitos

Escolha um dos seguintes ambientes:

• Ambiente Java: JDK 21+ e Maven 3.6+
• Ambiente Docker: Docker e Docker Compose

Início Rápido

Método 1: Executar com Java

# Clone the repository
git clone https://github.com/yyykf/yapi-mcp-server.git
cd yapi-mcp-server

# Configure Yapi URL and project tokens
vim src/main/resources/application-mcp.yml

# Build the project
mvn clean package

# Run the application
java -jar target/yapi-mcp-server-0.0.1-SNAPSHOT.jar

Método 2: Executar com Docker

# Clone the repository
git clone https://github.com/yyykf/yapi-mcp-server.git
cd yapi-mcp-server

# Configure Yapi URL and project tokens
vim src/main/resources/application-mcp.yml

# Run with Docker Compose
docker-compose up -d

Configuração

Antes de executar o aplicativo, você precisa configurar suas configurações de conexão Yapi em src/main/resources/application-mcp.yml:

spring:
  cloud:
    openfeign:
      client:
        config:
          yapiClient:
            url: http://yapi.com # Replace with your Yapi URL
yapi:
  project-tokens:
    123456: "your-project-token-1"  # Project ID: Token
    789012: "your-project-token-2"  # Add more projects as needed

Construindo Imagens Docker Multi-Arquitetura

Se você precisar construir e enviar imagens Docker multi-arquitetura manualmente, use o script fornecido:

./build-and-push.sh <version> <docker-username> <docker-password>

Exemplo:

./build-and-push.sh 1.0.0 myusername mypassword

Este script construirá imagens para as arquiteturas amd64 e arm64 e criará um manifesto multi-arquitetura.

Documentação

Para documentação mais detalhada do projeto e insights, você pode explorar o projeto usando o DeepWiki:

Integração com Cursor

Método 1: Instalação com Um Clique

Clique no botão abaixo para instalar automaticamente o servidor MCP no Cursor:

Método 2: Configuração Manual

Adicione a seguinte configuração ao seu arquivo de configurações MCP do Cursor (mcp.json):

{
  "mcpServers": {
    "yapi": {
      "url": "http://127.0.0.1:8888/sse"
    }
  }
}

Verificação de Saúde

Quando o aplicativo estiver em execução, você pode verificar seu status de saúde:

curl http://localhost:8888/actuator/health

Ou visite http://localhost:8888/actuator/health no seu navegador.

Exemplos de Uso

Após configurar o servidor MCP no Cursor, você pode usar linguagem natural para interagir com sua instância Yapi:

• "Mostre-me todos os projetos disponíveis"
• "Liste todas as categorias de API no projeto 123456"
• "Pesquise por APIs de login"
• "Obtenha detalhes do ID da interface 789"
• "Qual é o status do cache?"

Licença

Este projeto é licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.