你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
本教程介绍如何通过模型上下文协议(MCP)公开 Spring Boot Web 应用的功能,将其作为工具添加到 GitHub Copilot,并在 Copilot Chat 代理模式下使用自然语言与应用交互。
如果 Web 应用程序已具有有用的功能(如购物、酒店预订或数据管理),则可以轻松地使这些功能可供以下功能使用:
- 支持 MCP 集成的任何应用程序,例如 Visual Studio Code 或 GitHub Codespaces 中的 GitHub Copilot Chat 代理模式。
- 使用 MCP 客户端访问远程工具的自定义代理。
通过将 MCP 服务器添加到 Web 应用,可以在代理响应用户提示时了解和使用应用的功能。 这意味着你的应用可以执行的任何操作,智能助手也可以执行。
- 将 MCP 服务器添加到 Web 应用。
- 在 GitHub Copilot Chat 代理模式下本地测试 MCP 服务器。
- 将 MCP 服务器部署到 Azure 应用服务,并在 GitHub Copilot Chat 中连接到它。
Prerequisites
本教程假定你使用的是教程中使用的示例 :使用 Linux 和 Azure Cosmos DB 上的 Azure 应用服务生成 Java Spring Boot Web 应用。
至少,在 GitHub Codespaces 中打开 示例应用程序 ,并通过运行 azd up来部署应用。
将 MCP 服务器添加到 Web 应用
在 codespace 中,打开 pom.xml 并将
spring-ai-starter-mcp-server-webmvc包添加到项目中:<dependency> <groupId>org.springframework.ai</groupId> <artifactId>spring-ai-starter-mcp-server-webmvc</artifactId> <version>1.0.0</version> </dependency>打开 src/main/java/com/microsoft/azure/appservice/examples/springbootmongodb/TodoApplication.java。 为简单起见,将在此处添加所有 MCP 服务器代码。
在TodoApplication.java末尾,添加以下类。
@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"; } }上述代码使用以下特定属性为 Spring AI 提供工具:
-
@Service:将TodoListToolService标记为 Spring 管理的服务。 -
@Tool:将方法标记为 Spring AI 中的可调用工具。 -
description:它们为每个工具提供可读说明。 它可帮助调用代理了解如何使用该工具。
此代码复制现有 src/main/java/com/microsoft/azure/appservice/examples/springbootmongodb/controller/TodoListController.java的功能,这是不必要的,但为了简单起见,需要保留它。 最佳做法是将应用逻辑移到服务类,然后既从
TodoListController调用服务方法,又从TodoListToolService调用服务方法。-
在 TodoApplication.java中,将以下方法添加到
TodoApplication类。@Bean public ToolCallbackProvider todoTools(TodoListToolService todoListToolService) { return MethodToolCallbackProvider.builder().toolObjects(todoListToolService).build(); }此方法提供
TodoListToolService中的工具作为 Spring AI 的回调。 默认情况下,包中的spring-ai-starter-mcp-server-webmvcMCP 服务器自动配置会自动连接这些工具回调。 此外,默认情况下,MCP 服务器终结点为<base-url>/sse。在 TodoApplication.java顶部,添加以下导入。
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;
在本地测试 MCP 服务器
在 codespace 终端中,使用
mvn spring-boot:run.. 运行应用程序。在 浏览器中选择“打开”,然后添加任务。
使 Spring Boot 保持运行状态。 MCP 服务器终结点现已在
http://localhost:8080/sse运行。返回代码空间,打开 Copilot Chat,然后在提示框中选择 代理 模式。
选择 “工具 ”按钮,然后在下拉列表中选择“ 添加更多工具...” 。
选择 “添加 MCP 服务器”。
选择“HTTP(HTTP 或 Server-Sent 事件)”。
在 Enter 服务器 URL 中,键入 http://localhost:8080/sse。
在 Enter 服务器 ID 中,键入 todos-mcp 或任何喜欢的名称。
选择 工作区设置。
在新的 Copilot Chat 窗口中,键入类似于“显示待办事项”的内容。
默认情况下,GitHub Copilot 在调用 MCP 服务器时会显示安全确认。 选择继续。
现在应会看到一个响应,指示 MCP 工具调用成功。
将 MCP 服务器部署到应用服务
返回 codespace 终端,通过提交更改(GitHub Actions 方法)或运行
azd up(Azure 开发人员 CLI 方法)来部署更改。在 AZD 输出中,找到应用的 URL。 该 URL 在 AZD 输出中如下所示:
Deploying services (azd deploy) (✓) Done: Deploying service web - Endpoint: <app-url>
azd up完成后,打开 .vscode/mcp.json。 将 URL 更改为<app-url>/sse。在修改后的 MCP 服务器配置上方,选择“ 开始”。
启动新的 GitHub Copilot 聊天窗口。 你应该能够在 Copilot 代理中查看、创建、更新和删除任务。
安全最佳做法
当 MCP 服务器由由大型语言模型(LLM)提供支持的代理调用时,请注意 提示注入 攻击。 请考虑以下安全最佳做法:
- 身份验证和授权:使用 Microsoft Entra 身份验证保护 MCP 服务器,以确保只有经过授权的用户或代理才能访问工具。 有关分步指南,请参阅 使用 Microsoft Entra 身份验证通过 Visual Studio Code 对 Azure 应用服务的安全模型上下文协议调用 。
- 输入验证和清理:本教程中的示例代码省略输入验证和清理,以便简单明了。 在生产方案中,始终实现适当的验证和清理来保护应用程序。 对于 Spring,请参阅 Spring:验证表单输入。
- HTTPS: 此示例依赖于 Azure 应用服务,该服务默认强制实施 HTTPS,并提供免费的 TLS/SSL 证书来加密传输中的数据。
- 最低特权原则:仅公开用例所需的工具和数据。 除非必要,否则避免公开敏感操作。
- 速率限制和限制:使用 API 管理 或自定义中间件来防止滥用和拒绝服务攻击。
- 日志记录和监视:用于审核和异常检测的 MCP 终结点的日志访问和使用情况。 监视可疑活动。
- CORS 配置:如果从浏览器访问 MCP 服务器,请将跨域请求限制为受信任的域。 有关详细信息,请参阅 “启用 CORS”。
- 常规更新:使依赖项保持最新,以缓解已知漏洞。