Sobre servidores MCP

O Model Context Protocol (MCP) é um protocolo aberto que cria conexões padronizadas entre aplicativos de IA e serviços externos, como a documentação. A Mintlify gera um servidor MCP a partir da sua documentação e das especificações OpenAPI, preparando seu conteúdo para o ecossistema de IA mais amplo, onde qualquer cliente MCP (como Claude, Cursor, Goose e outros) pode se conectar à sua documentação e às suas APIs. Seu servidor MCP expõe ferramentas para que aplicativos de IA pesquisem sua documentação e interajam com suas APIs.

Acessando seu servidor MCP

Servidores MCP só podem ser gerados para documentação pública. Documentação protegida por autenticação de usuário final não pode ser acessada para geração do servidor.
A Mintlify gera automaticamente um servidor MCP para sua documentação e o hospeda na URL da sua documentação com o caminho /mcp. Por exemplo, o servidor MCP da Mintlify está disponível em https://mintlify.com/docs/mcp. Você pode ver e copiar a URL do seu servidor MCP no seu dashboard. O caminho /mcp é reservado para servidores MCP hospedados e não pode ser usado para outros elementos de navegação.

Configurando seu servidor MCP

Todos os servidores MCP incluem a ferramenta search por padrão, permitindo que os usuários consultem informações da sua documentação em outras ferramentas. Se você tiver um plano Pro ou Enterprise, poderá expor endpoints da sua especificação OpenAPI como ferramentas MCP. Para expor endpoints como ferramentas MCP, use o objeto mcp dentro da extensão x-mint no nível do arquivo ou do endpoint. Por exemplo, o servidor MCP da Mintlify inclui ferramentas para criar chats do Assistente, obter atualizações de status e disparar atualizações. Os servidores MCP adotam uma abordagem de segurança em primeiro lugar, na qual endpoints de API não são expostos por padrão. Você deve habilitar explicitamente os endpoints para disponibilizá-los como ferramentas MCP. Exponha apenas endpoints que sejam seguros para acesso público por meio de ferramentas de IA.
mcp
object
A configuração do MCP para o endpoint.

Configuração em nível de arquivo

Habilite o MCP para todos os endpoints por padrão em um arquivo de especificação OpenAPI e exclua endpoints seletivamente:
{
  "openapi": "3.1.0",
  "x-mint": {
    "mcp": {
      "enabled": true
    }
  },
  // ...
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": false // Desativa o MCP para este endpoint
          }
        },
        // ...
      }
    }
  }
}

Configuração no nível do endpoint

Ative o MCP para endpoints específicos:
{
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": true,
            "name": "get-users",
            "description": "Obter uma lista de usuários"
          },
          // ...
        }
      }
    },
    "/api/v1/delete": {
      "delete": {
        // Sem `x-mint: mcp`, este endpoint não é exposto como uma ferramenta MCP
        // ...
      }
    }
  }
}

Usando seu servidor MCP

Seus usuários precisam conectar seu servidor MCP às ferramentas de IA que preferirem.
  1. Disponibilize publicamente a URL do seu servidor MCP.
  2. Os usuários copiam a URL do seu servidor MCP e a adicionam às suas ferramentas.
  3. Os usuários acessam sua documentação e os endpoints da API por meio dessas ferramentas.
Aqui estão algumas maneiras de ajudar seus usuários a se conectarem ao seu servidor MCP:

Exemplo: Conectando ao servidor MCP da Mintlify

Conecte-se ao servidor MCP da Mintlify para interagir com a API da Mintlify e pesquisar nossa documentação. Isso fornecerá respostas mais precisas sobre como usar a Mintlify no seu ambiente local e demonstra como você pode ajudar seus usuários a se conectarem ao seu servidor MCP.

Autenticação

Quando você habilita um endpoint de API para MCP, o servidor inclui os requisitos de autenticação definidos nos securitySchemes e securityRequirement do seu OpenAPI. Quaisquer chaves são gerenciadas diretamente pela ferramenta e não são armazenadas ou processadas pela Mintlify. Se um usuário pedir para a sua ferramenta de IA chamar um endpoint protegido, a ferramenta solicitará as credenciais de autenticação necessárias ao usuário naquele momento.

Monitorando seu servidor MCP

Você pode visualizar todas as ferramentas MCP disponíveis na seção Available tools da página MCP Server no seu painel.
Painel do MCP com a seção Available tools destacada

Solução de problemas