Controller Register Tool FAQs

Question 1

Can I control which APIs are registered or customize their names?

Accepted Answer

APIs are only registered if they are explicitly annotated with `@McpTool`. Currently, tool names are automatically generated based on the Controller class name and the API path (e.g., `/user/api/users/list`). Future updates are planned to introduce a `name` attribute in the `@McpTool` annotation for custom naming.

Question 2

What is the Controller Register Tool (MCP Tool)?

Accepted Answer

The Controller Register Tool is a module designed to automate the registration of Spring Boot Controller interfaces as callable tools. It enables intelligent agents, such as AgentScope, to easily discover, understand, and invoke your Spring Boot APIs.

Question 3

How do I expose my Spring Boot APIs as callable tools?

Accepted Answer

You simply need to add the `@McpTool` annotation to the specific Spring Boot Controller methods you wish to expose. The tool automatically scans these methods upon service startup, registers them, and makes them available without requiring any modifications to your existing business logic.

Question 4

Does the Controller Register Tool integrate with Swagger/OpenAPI?

Accepted Answer

Yes, it offers seamless integration with Swagger/OpenAPI. It leverages Swagger definitions to enrich tool descriptions and accurately generate input schemas, even for complex object types, significantly enhancing the agents' understanding of your API parameters.

Controller Register Tool

Controller Register Tool

Key Features

Use Cases

Key Features

Use Cases