Package io.quarkus.devui.spi.buildtime

Annotation Interface DevMcpBuildTimeTool

@Retention(RUNTIME) @Target(TYPE) @Documented @Repeatable(DevMcpBuildTimeTools.class) public @interface DevMcpBuildTimeTool
Declares a build-time MCP tool that is enabled by default. Place this annotation on a @BuildStep processor class to make the tool discoverable via Jandex scanning at build time.

This annotation is the deployment-time counterpart of JsonRpcDescription + DevMCPEnableByDefault used on runtime JSON-RPC methods. It allows the aggregate-skills Maven goal to discover build-time MCP tools without parsing source code. 

 @DevMcpBuildTimeTool(name = "runTests", description = "Run all tests", params = {
         @DevMcpParam(name = "className", description = "Test class name", required = false)
 })
 public class TestingProcessor {
     // ...
 }

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    A human-readable description of what this tool does.
    String
    name
    The tool name, matching the methodName in the BuildTimeActionBuildItem builder chain.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    DevMcpParam[]
    params
    The parameters this tool accepts.

  • Element Details

    • name

      String name
      The tool name, matching the methodName in the BuildTimeActionBuildItem builder chain.

    • description

      String description
      A human-readable description of what this tool does.

    • params

      DevMcpParam[] params
      The parameters this tool accepts. Defaults to no parameters.
      Default:
      {}