Integration Builder

Desenvolvedor

Dica

Instalar uma integração existente está disponível para todos os usuários. Criar novos templates requer role SUPERADMIN ou ADMIN.

Visão Geral

O MCP Gateway permite que você instale e crie integrações diretamente do seu assistente de codificação — sem precisar sair da IDE.

• Instalar uma integração existente — navegue pelo catálogo, forneça suas credenciais e settings, e ative imediatamente usando install_integration.
• Criar um novo template de integração — descreva o serviço que quer conectar, e o Prodgy constrói o template completo (requer role SUPERADMIN).

Uma vez instalada, as ferramentas da integração aparecem automaticamente na conexão MCP de cada membro do time.

---

Instalando uma Integração Existente

Se a integração que você precisa já existe no catálogo do Prodgy, você pode instalá-la diretamente da sua IDE:

1. Navegue pelo catálogo

"Liste as integrações disponíveis no Prodgy"

A IA chamará list_integration_catalog para mostrar todos os templates disponíveis (Azure DevOps, Jira, Slack, GitHub, etc.).

2. Verifique as credenciais e settings necessários

"Mostre os detalhes da integração Azure DevOps"

A IA chamará get_integration para mostrar os campos de credenciais necessários (ex: personalAccessToken) e settings (ex: project_url, project_name).

3. Instale com suas credenciais

"Instale a integração Azure DevOps com meu PAT token xyz123 para https://dev.azure.com/myorg, projeto MyProject"

Você também pode especificar um nome customizado e escopo:

"Instale a integração Azure DevOps como 'Azure DevOps — Backend' somente para este workspace"

A IA chamará install_integration que:

1. Valida suas credenciais contra o serviço externo (se o template tiver validação configurada)
2. Cria a instância da integração com o nome e escopo informados (Local ou Global)
3. Armazena credenciais de forma segura (criptografadas, no servidor)
4. Ativa a integração imediatamente — as ferramentas ficam disponíveis na hora

É possível instalar múltiplas instâncias do mesmo tipo de integração, cada uma com credenciais e escopo diferentes — útil quando diferentes produtos conectam a projetos distintos.

Dica

Sem necessidade de ir à UI do Prodgy! Todo o fluxo — desde navegar pelo catálogo até ter as ferramentas funcionando — acontece dentro da sua IDE.

4. Use as novas ferramentas

Uma vez instalada, as ferramentas da integração ficam disponíveis imediatamente:

"Liste work items abertos no Azure DevOps atribuídos a mim"

"Crie uma issue no GitHub para o bug de autenticação que acabamos de discutir"

---

Criando um Novo Template de Integração

Se a integração que você precisa não existe no catálogo, você pode criá-la (requer role SUPERADMIN/ADMIN).

1. Crie o template

Peça ao seu assistente de codificação para criar uma integração. Para serviços conhecidos, ele já conhece a estrutura da API:

"Crie uma integração com o Zendesk com ferramentas para listar tickets, criar tickets e atualizar status de tickets"

A IA usará create_integration para construir um template completo com:

• Schema de autenticação — como as credenciais são estruturadas (API key, Bearer token, OAuth2, etc.)
• Campos de configuração — o que o admin preenche depois (URL do tenant, nome do projeto, subdomínio, etc.)
• Ferramentas de API — cada ação disponível como uma ferramenta MCP, com endpoints, parâmetros e mapeamento de resposta

Nota

O template usa placeholders como ${settings.tenant_url} e ${credentials.apiKey}. Nenhuma credencial real é necessária no momento da criação — essas são configuradas na instalação.

2. Inspecione e refine

Use list_integration_catalog para ver todos os templates disponíveis, e get_integration para inspecionar um específico:

"Mostre os detalhes do template de integração do Zendesk"

Precisa adicionar mais ferramentas ou corrigir algo? Use update_integration:

"Adicione uma ferramenta na integração do Zendesk para buscar tickets por status"

3. Instale o novo template

Após criar o template, instale-o imediatamente usando install_integration:

"Instale a integração Zendesk com minha API key e subdomínio"

Alternativamente, o administrador da organização pode ativá-la pela UI do Prodgy: Configurações > Integrações.

---

Ferramentas Disponíveis

Ferramenta	Role	Descrição
list_integration_catalog	Qualquer	Lista todos os templates de integração disponíveis
get_integration	Qualquer	Obtém detalhes completos de um template (credenciais, settings, ferramentas)
list_installed_integrations	Qualquer	Lista integrações instaladas na organização
install_integration	Qualquer	Instala um template com credenciais, settings, title opcional e product_id (para escopo Local)
create_integration	SUPERADMIN/ADMIN	Cria um novo template de integração
update_integration	SUPERADMIN/ADMIN	Atualiza um template existente (adicionar ferramentas, corrigir configuração)
delete_integration	SUPERADMIN/ADMIN	Remove um template do catálogo

---

Boas Práticas

Seja específico sobre as ferramentas que precisa

Em vez de “Crie uma integração com o Jira”, tente:

"Crie uma integração com o Jira Cloud com ferramentas para:
- Listar issues por projeto e status
- Criar novas issues com resumo, descrição e prioridade
- Atualizar status de issues
- Adicionar comentários em issues"

Deixe a IA cuidar dos detalhes da API

Para serviços conhecidos (Jira, GitHub, Slack, Zendesk, Workday, etc.), a IA já conhece a estrutura da API. Você só precisa especificar:

1. Qual serviço integrar
2. Quais ações/ferramentas você precisa
3. Qual tipo de autenticação usar (se não tiver certeza, a IA sugere)

Use nomes genéricos nas ferramentas

Nomes de ferramentas devem ser genéricos, sem prefixo do nome da integração:

Correto	Incorreto
list_tickets	zendesk_list_tickets
create_issue	jira_create_issue
send_message	slack_send_message

Isso permite que o mesmo nome de ferramenta funcione entre múltiplas integrações com desambiguação automática.

Itere incrementalmente

Comece com as ferramentas mais importantes, ative a integração, teste, e depois adicione mais ferramentas conforme necessário. É mais fácil construir incrementalmente do que acertar tudo de primeira.