Skip to content

注解参考

mcp-annotations 是 Server2MCP 框架的基石,它提供了一套完整的 Java 注解,用于将您的业务逻辑声明式地暴露给 AI。

设计哲学

  • 声明式: 通过为方法添加注解,即可将其转换为 AI 可理解和调用的能力(如工具、资源、提示词等),无需编写繁琐的适配代码。
  • 类型安全: 借助 Java 的类型系统,尽可能在编译期保证调用的正确性。
  • 高度解耦: 注解本身不包含任何业务逻辑,仅作为元数据标记,使您的核心代码保持纯净。

注解分类

为了方便您的查阅,我们将所有注解和相关功能划分为了以下几类:

  • 核心定义注解
    用于声明 AI 能力(工具、资源、提示词)的基础注解,例如 @McpTool@McpArg

  • 上下文注入
    讲解 @McpTool 的高级用法,例如如何自动注入 McpLogger 以实现与客户端的实时通信。

  • 自动补全
    关于 @McpComplete 注解的详细说明,用于为资源和提示词提供动态输入建议。

  • 回调与消费:学习如何使用 @McpLoggingConsumer 等注解来消费和处理来自客户端的事件。