Pular para o conteúdo principal

Visão geral

O que você vai fazer:
  • Adicionar o servidor MCP do ABBYY Vantage ao GitHub Copilot no VS Code
  • Verificar se a conexão está funcionando
  • Usar a ferramenta SearchAbbyyVantageDocumentation para pesquisar a documentação no Copilot Chat
Tempo para concluir: ~5 minutos

O que é o servidor MCP?

O Model Context Protocol (MCP) é um padrão aberto que permite que assistentes de IA se conectem a ferramentas externas e fontes de dados. Ao adicionar um servidor MCP ao GitHub Copilot, você dá à IA acesso direto a dados estruturados ou recursos — sem precisar copiar e colar conteúdo manualmente. O servidor MCP do ABBYY Vantage expõe uma única ferramenta, SearchAbbyyVantageDocumentation, que realiza uma busca semântica em toda a documentação do Vantage. Quando o Copilot tem esse servidor conectado, ele pode consultar parâmetros da API, opções de configuração de skill, etapas de solução de problemas e muito mais — automaticamente, enquanto você trabalha.
O servidor MCP fornece acesso somente leitura à documentação pública. Ele não se conecta ao seu tenant do Vantage, não processa documentos nem exige credenciais do Vantage.

Pré-requisitos

  • VS Code versão 1.99 ou mais recente (suporte a MCP obrigatório)
  • Extensão GitHub Copilot instalada e com login realizado
Não é necessário ter tenant nem conta do ABBYY Vantage para usar o servidor MCP.

1

Adicionar pela Paleta de Comandos (Recomendado)

Use a Paleta de Comandos do VS Code para registrar o servidor MCP:
  1. Abra a Paleta de Comandos com Cmd+Shift+P (macOS) ou Ctrl+Shift+P (Windows/Linux)
  2. Digite “MCP: Add Server…” e selecione essa opção
  3. Selecione HTTP como tipo de transporte
  4. Insira a URL: https://docs.abbyy.com/mcp
  5. Insira o nome: abbyy-vantage
  6. Escolha o escopo: Workspace ou User
EscopoLocal da configuraçãoQuando usar
Workspace.vscode/mcp.jsonUm projeto específico
UserConfigurações do usuário pela Paleta de ComandosTodos os projetos nesta máquina
2

Alternativa: Configuração manual

Se preferir configurar manualmente, adicione a entrada do servidor ao arquivo de configuração apropriado.
Crie ou edite .vscode/mcp.json na raiz do projeto:
{
  "servers": {
    "abbyy-vantage": {
      "type": "http",
      "url": "https://docs.abbyy.com/mcp"
    }
  }
}
Abra a Paleta de Comandos (Cmd+Shift+P / Ctrl+Shift+P), digite “MCP: Open User Configuration” e adicione a seguinte entrada:
{
  "servers": {
    "abbyy-vantage": {
      "type": "http",
      "url": "https://docs.abbyy.com/mcp"
    }
  }
}
3

Verifique a conexão

  1. Abra a Paleta de Comandos e execute “MCP: List Servers” — confirme que abbyy-vantage aparece como conectado
  2. Abra o Copilot Chat (clique no ícone do Copilot na barra lateral ou pressione Ctrl+Shift+I / Cmd+Shift+I)
  3. Mude para o modo Agent usando o seletor de modo na parte superior do painel de chat
  4. Clique no ícone de ferramentas no campo de entrada do chat — confirme que SearchAbbyyVantageDocumentation aparece na lista
  5. Teste com uma pergunta:
“Quais parâmetros a API de Processing do Vantage exige para enviar um documento?”
O Copilot invocará SearchAbbyyVantageDocumentation e retornará resultados da documentação.
A URL deve ser inserida exatamente como https://docs.abbyy.com/mcp, sem barra no final. Confirme também que o VS Code tem acesso à rede para alcançar o servidor.

Ferramentas disponíveis

O servidor MCP do ABBYY Vantage disponibiliza uma ferramenta: SearchAbbyyVantageDocumentation Realiza uma pesquisa semântica na documentação do ABBYY Vantage e retorna o conteúdo mais relevante. O Copilot invoca essa ferramenta automaticamente no Agent quando você faz perguntas relacionadas ao Vantage. Exemplos de consultas:
  • “Como configuro uma Skill de Documento no Vantage?”
  • “Para que serve o parâmetro minConfidence?”
  • “Como configuro uma conexão com LLM no Vantage?”
  • “Quais formatos de exportação o Vantage oferece?”
  • “Como faço a autenticação na API REST do Vantage?”

Casos de Uso

Integrações de API

Consulte parâmetros de endpoint, métodos de autenticação e formatos de requisição/resposta sem sair da sua IDE

Configuração de Skill

Encontre rapidamente opções de configuração e práticas recomendadas para Skills de Documento, Skills de Processo e Advanced Designer

Resolução de Problemas

Localize mensagens de erro e problemas conhecidos para resolver issues mais rapidamente durante a depuração de integrações

Exploração de Recursos

Descubra o que o Vantage oferece — modelos de extração, formatos compatíveis e configurações de tenant — enquanto planeja seu projeto

Dicas para consultas eficazes

  • Seja específico: inclua o nome do recurso ou o endpoint da API na sua pergunta, em vez de fazer uma pergunta genérica
  • Use a terminologia do Vantage: termos como “Skill de Processo”, “Skill de Documento”, “Skill Designer” e “tenant” geram resultados mais precisos
  • Faça perguntas de acompanhamento: o Copilot mantém o contexto, então você pode refinar os resultados com perguntas complementares
  • Combine com seu código: cole uma resposta da API ou um snippet de configuração e peça ao Copilot para explicá-lo com base na documentação do Vantage
  • Use o modo Agent: as ferramentas MCP só estão disponíveis no modo Agent — verifique se o seletor de modo está definido como “Agent” antes de perguntar

Removendo o servidor MCP

Você pode remover o servidor usando um destes métodos: Pela Paleta de Comandos:
  1. Abra a Paleta de Comandos (Cmd+Shift+P / Ctrl+Shift+P)
  2. Execute “MCP: List Servers”
  3. Selecione abbyy-vantage
  4. Escolha Remove
Pelo arquivo de configuração: Exclua a entrada abbyy-vantage de .vscode/mcp.json (workspace) ou da configuração de MCP do usuário.

Solução de problemas

O servidor não aparece em “MCP: List Servers” Verifique se o arquivo de configuração foi salvo corretamente e se o JSON é válido (sem vírgulas no final). Se você editou o arquivo manualmente, tente recarregar o VS Code (Developer: Reload Window na Paleta de Comandos). Versão do VS Code muito antiga O suporte a MCP requer o VS Code 1.99 ou posterior. Verifique sua versão em Help → About e atualize, se necessário. A ferramenta não é acionada automaticamente O Copilot só aciona ferramentas MCP no modo Agent. Verifique se você mudou do modo “Ask” ou “Edit” para “Agent” usando o seletor de modo na parte superior do painel do Copilot Chat. Se a ferramenta ainda não estiver sendo usada, tente fazer sua pergunta de forma mais explícita: “Pesquise na documentação do ABBYY Vantage por…” ou mencione pelo nome um recurso específico do Vantage. A pesquisa retorna resultados irrelevantes Reformule sua consulta usando termos da interface ou da documentação do Vantage. Evite usar termos genéricos como “workflow” ou “settings” sozinhos — combine-os com “Vantage” ou com o nome de um recurso específico.

Resumo

Você concluiu com sucesso:
  • ✅ Adicionou o servidor MCP do ABBYY Vantage ao GitHub Copilot no VS Code
  • ✅ Verificou a conexão usando “MCP: List Servers”
  • ✅ Aprendeu a acionar a busca na documentação pelo Copilot Chat no Agent

Próximos passos

Introdução à API

Comece a usar a API REST de processamento do Vantage

Processamento de documentos

Crie uma Skill de Processo e automatize o processamento de documentos via SFTP

Configuração de conexões com LLM

Conecte o Vantage à OpenAI ou ao Microsoft Foundry

Extração baseada em prompts

Use prompts em linguagem natural para extrair dados de documentos

Servidor MCP para Claude Code

Adicione o mesmo servidor MCP ao Claude Code