Mcp

Visão Geral

O Model Context Protocol (MCP) é um protocolo aberto que conecta suas funções a LLMs e aplicações de IA. Com a integração da Mintlify, você pode gerar automaticamente um servidor MCP a partir da sua documentação existente ou especificações OpenAPI, permitindo interações perfeitas com IA com seu produto.

Guia de Uso Rápido

Qualquer documentação pública hospedada na Mintlify pode ser extraída como um servidor MCP usando um comando simples:

npx mint-mcp add <your-subdomain-or-domain>

Examples:

# Using subdomain
npx mint-mcp add mintlify

# Using domain
npx mint-mcp add mintlify.com

Autenticação

Quando você executar o comando, você precisará fornecer duas chaves de API, External Admin Key e Assistant API Key.

Estas podem ser encontradas no seu Painel Mintlify em Configurações > Chaves de API.

Selecionar Clientes MCP

Após a autenticação, você escolherá quais clientes MCP habilitar para o seu servidor:

Uma vez configurado, seu servidor MCP está pronto para uso com o comando fornecido no terminal.

Configurando Seu Servidor MCP

Agora vamos dar uma olhada em como configurar seu servidor MCP.

Funcionalidade Padrão

Todos os servidores MCP incluem a ferramenta search por padrão, permitindo que os usuários consultem informações em toda a sua documentação.

Adicionando Funções de API

Se você tem uma especificação OpenAPI, você pode expor endpoints específicos como ferramentas MCP usando a extensão x-mcp no nível do arquivo ou do endpoint.

Configuração em Nível de Arquivo

Habilite o MCP para todos os endpoints em um arquivo de especificação:

{
  "openapi": "3.1.0",
  "x-mcp": {
    "enabled": true
  },
  // Other OpenAPI content
}

Configuração em Nível de Endpoint

Habilite o MCP apenas para endpoints específicos:

{
  "paths": {
    "/api/v1/users": {
      "x-mcp": {
        "enabled": true
      },
      // Endpoint configuration
    }
  }
}

Tratamento de Autenticação

Se sua especificação OpenAPI define autenticação usando securitySchemes, esses métodos de autenticação serão aplicados automaticamente ao seu servidor MCP.

Monitorando Seu Servidor MCP

Após publicar suas alterações, você pode visualizar todas as ferramentas MCP disponíveis na seção Ferramentas Disponíveis na página do servidor MCP no seu painel.

Distribuição

Instalação do Usuário

Seus usuários podem instalar e usar seu servidor MCP com:

npx mint-mcp add <your-subdomain-or-domain>

Isso fornece a eles um servidor MCP pronto para uso que conecta suas funções documentadas a aplicações de IA.