Compartilhar via


Integrar um aplicativo do Serviço de Aplicativo como um MCP Server para o GitHub Copilot Chat (Spring Boot)

Neste tutorial, você aprenderá a expor a funcionalidade de um aplicativo Web Spring Boot por meio do Protocolo de Contexto de Modelo (MCP), adicioná-lo como uma ferramenta ao GitHub Copilot e interagir com seu aplicativo usando linguagem natural no modo de agente do Copilot Chat.

Captura de tela mostrando o GitHub Copilot chamando o servidor Todos MCP hospedado no Serviço de Aplicativo do Azure.

Se seu aplicativo Web já tiver recursos úteis, como compras, reservas de hotéis ou gerenciamento de dados, é fácil disponibilizar esses recursos para:

Ao adicionar um servidor MCP ao seu aplicativo Web, você permite que um agente entenda e use os recursos do aplicativo quando ele responder aos prompts do usuário. Isso significa que tudo o que seu aplicativo pode fazer, o agente também pode fazer.

  • Adicione um servidor MCP ao seu aplicativo Web.
  • Teste o servidor MCP localmente no modo de agente do GitHub Copilot Chat.
  • Implante o servidor MCP no Serviço de Aplicativo do Azure e conecte-se a ele no GitHub Copilot Chat.

Prerequisites

Este tutorial pressupõe que você esteja trabalhando com o exemplo usado no Tutorial: Criar um aplicativo Web Java Spring Boot com o Serviço de Aplicativo do Azure no Linux e no Azure Cosmos DB.

No mínimo, abra o aplicativo de exemplo nos Codespaces do GitHub e implante o aplicativo executando azd up.

Adicionar o servidor MCP ao seu aplicativo Web

  1. No codespace, abra pom.xml e adicione o spring-ai-starter-mcp-server-webmvc pacote ao seu projeto:

    <dependency>
        <groupId>org.springframework.ai</groupId>
        <artifactId>spring-ai-starter-mcp-server-webmvc</artifactId>
        <version>1.0.0</version>
    </dependency>
    
  2. Abra src/main/java/com/microsoft/azure/appservice/examples/springbootmongodb/TodoApplication.java. Para simplificar o cenário, você adicionará todo o código do servidor MCP aqui.

  3. No final de TodoApplication.java, adicione a classe a seguir.

    @Service
    class TodoListToolService {
        private final TodoItemRepository todoItemRepository;
    
        public TodoListToolService(TodoItemRepository todoItemRepository) {
            this.todoItemRepository = todoItemRepository;
        }
    
        @Tool(description = "Get a todo item by its id")
        public Optional<TodoItem> getTodoItem(String id) {
            return todoItemRepository.findById(id);
        }
    
        @Tool(description = "Get all todo items")
        public List<TodoItem> getAllTodoItems() {
            return todoItemRepository.findAll();
        }
    
        @Tool(description = "Add a new todo item")
        public String addNewTodoItem(String description, String owner) {
            TodoItem item = new TodoItem(UUID.randomUUID().toString(), description, owner);
            todoItemRepository.save(item);
            return "Todo item created";
        }
    
        @Tool(description = "Update an existing todo item")
        public String updateTodoItem(String id, String description, String owner, boolean finished) {
            if (!todoItemRepository.existsById(id)) {
                return "Todo item not found";
            }
            TodoItem item = new TodoItem(id, description, owner);
            item.setFinish(finished);
            todoItemRepository.save(item);
            return "Todo item updated";
        }
    
        @Tool(description = "Delete a todo item by its id")
        public String deleteTodoItem(String id) {
            if (!todoItemRepository.existsById(id)) {
                return "Todo item not found";
            }
            todoItemRepository.deleteById(id);
            return "Todo item deleted";
        }
    }
    

    O código acima disponibiliza ferramentas para IA do Spring usando os seguintes atributos específicos:

    • @Service: marca TodoListToolService como um serviço gerenciado pelo Spring.
    • @Tool: marca um método como uma ferramenta que pode ser chamada na IA do Spring.
    • description: elas fornecem descrições legíveis por humanos para cada ferramenta. Ele ajuda o agente de chamada a entender como usar a ferramenta.

    Esse código está duplicando a funcionalidade do src/main/java/com/microsoft/azure/appservice/examples/springbootmongodb/controller/TodoListController.java existente, o que é desnecessário, mas você o manterá para simplificar. Uma prática recomendada seria mover a lógica do aplicativo para uma classe de serviço e, em seguida, chamar os métodos de serviço tanto de TodoListController quanto de TodoListToolService.

  4. Em TodoApplication.java, adicione o método a seguir à TodoApplication classe.

    @Bean
    public ToolCallbackProvider todoTools(TodoListToolService todoListToolService) {
        return MethodToolCallbackProvider.builder().toolObjects(todoListToolService).build();
    }
    

    Esse método fornece as ferramentas em TodoListToolService como callbacks para o Spring AI. Por padrão, a configuração automática do SERVIDOR MCP no pacote spring-ai-starter-mcp-server-webmvc conecta automaticamente esses retornos de chamada de ferramenta. Além disso, por padrão, o ponto de extremidade do servidor MCP é <base-url>/sse.

  5. Na parte superior do TodoApplication.java, adicione as seguintes importações.

    import java.util.List;
    import java.util.Optional;
    import java.util.UUID;
    
    import org.springframework.ai.tool.ToolCallbackProvider;
    import org.springframework.ai.tool.annotation.Tool;
    import org.springframework.ai.tool.method.MethodToolCallbackProvider;
    import org.springframework.context.annotation.Bean;
    import org.springframework.stereotype.Service;
    
    import com.microsoft.azure.appservice.examples.springbootmongodb.dao.TodoItemRepository;
    import com.microsoft.azure.appservice.examples.springbootmongodb.model.TodoItem;
    

Testar o servidor MCP localmente

  1. No terminal do codespace, execute o aplicativo com mvn spring-boot:run.

  2. Selecione Abrir no Navegador e, em seguida, adicione uma tarefa.

    Deixe o Spring Boot em execução. O ponto de extremidade do servidor MCP está em execução a http://localhost:8080/sse momento.

  3. De volta ao codespace, abra o Copilot Chat e, em seguida, selecione o modo Agente na caixa de prompt.

  4. Selecione o botão Ferramentas e, em seguida, selecione Adicionar Mais Ferramentas... na lista suspensa.

    Captura de tela mostrando como adicionar um servidor MCP no modo de agente do GitHub Copilot Chat.

  5. Selecione Adicionar Servidor MCP.

  6. Selecione HTTP (HTTP ou Eventos Server-Sent).

  7. Na URL do Servidor Enter, digite http://localhost:8080/sse.

  8. No Enter Server ID, digite todos-mcp ou qualquer nome que você quiser.

  9. Selecione Configurações do Workspace.

  10. Em uma nova janela do Copilot Chat, digite algo como "Mostre-me as tarefas pendentes".

  11. Por padrão, o GitHub Copilot mostra uma confirmação de segurança quando você invoca um servidor MCP. Selecione Continuar.

    Captura de tela mostrando a mensagem de segurança padrão de uma invocação MCP no GitHub Copilot Chat.

    Agora você deve ver uma resposta que indica que a chamada à ferramenta MCP foi bem-sucedida.

    Captura de tela mostrando que a resposta da chamada da ferramenta MCP na janela de Chat do GitHub Copilot.

Implantar o servidor MCP no Serviço de Aplicativo

  1. De volta ao terminal do codespace, implante suas alterações confirmando suas alterações (método GitHub Actions) ou execute azd up (método da CLI do Desenvolvedor do Azure).

  2. Na saída do AZD, localize a URL do seu aplicativo. O URL fica assim na saída do AZD:

     Deploying services (azd deploy)
    
       (✓) Done: Deploying service web
       - Endpoint: <app-url>
     
  3. Após o término de azd up, abra .vscode/mcp.json. Altere a URL para <app-url>/sse.

  4. Acima da configuração do servidor MCP modificado, selecione Iniciar.

    Captura de tela mostrando como iniciar manualmente um servidor MCP do arquivo de mcp.json local.

  5. Inicie uma nova janela do GitHub Copilot Chat. Você deve ser capaz de exibir, criar, atualizar e excluir tarefas no agente copilot.

Melhores práticas de segurança

Quando o servidor MCP for chamado por um agente alimentado por LLM (grandes modelos de linguagem), esteja ciente dos ataques de injeção de prompt. Considere as seguintes práticas recomendadas de segurança:

  • Autenticação e autorização: proteja seu servidor MCP com a autenticação do Microsoft Entra para garantir que somente usuários ou agentes autorizados possam acessar suas ferramentas. Confira Chamadas de Protocolo de Contexto de Modelo Seguro para o Serviço de Aplicativo do Azure do Visual Studio Code com a autenticação do Microsoft Entra para obter um guia passo a passo.
  • Validação e sanitização de entrada: o código de exemplo neste tutorial omite a validação e a sanitização de entrada para simplicidade e clareza. Em cenários de produção, sempre implemente a validação e a sanitização adequadas para proteger seu aplicativo. Para o Spring, consulte Spring: Validando a entrada do formulário.
  • HTTPS: O exemplo depende do Serviço de Aplicativo do Azure, que impõe HTTPS por padrão e fornece certificados TLS/SSL gratuitos para criptografar dados em trânsito.
  • Princípio de Privilégio Mínimo: exponha apenas as ferramentas e os dados necessários para seu caso de uso. Evite expor operações confidenciais, a menos que seja necessário.
  • Limitação de taxa e limitação: use o Gerenciamento de API ou middleware personalizado para evitar ataques de abuso e negação de serviço.
  • Registro em log e monitoramento: acesso de log e uso de pontos de extremidade MCP para auditoria e detecção de anomalias. Monitore atividades suspeitas.
  • Configuração do CORS: restrinja solicitações entre origens a domínios confiáveis se o servidor MCP for acessado de navegadores. Para obter mais informações, consulte Habilitar CORS.
  • Atualizações regulares: mantenha suas dependências atualizadas para atenuar vulnerabilidades conhecidas.

Mais recursos