Class McpSnmpMessageBER

java.lang.Object
org.snmp4j.mcp.tool.snmp.ber.McpSnmpMessageBER
All Implemented Interfaces:
McpTool
public class McpSnmpMessageBER extends Object implements McpTool
MCP tool that parses a raw SNMP message from a hex string and returns its BER structure as a text tree or JSON object tree.

Supports SNMPv1, SNMPv2c, and SNMPv3, including decryption of AUTH_PRIV ScopedPDUs when matching SNMPv3 target credentials (with an authoritativeEngineID) are present in the server configuration.

Since:
0.1.0

  • Field Details

    • TOOL_ID

      public static final String TOOL_ID
      Tool ID registered with the MCP server ("snmp_message_ber").
      See Also:

    • BER_RESULT_SCHEMA_RESOURCE_URI

      public static final String BER_RESULT_SCHEMA_RESOURCE_URI
      MCP resource URI for the BER result JSON schema.
      See Also:

  • Constructor Details

    • McpSnmpMessageBER

      public McpSnmpMessageBER(Supplier<List<SnmpMcpServer.ServerConfiguration.SnmpTargetConfig>> targetsSupplier)
      Creates a new BER parser tool.
      Parameters:
      targetsSupplier - supplies the list of configured SNMPv3 targets whose credentials are used for deferred key localization when decrypting AUTH_PRIV PDUs

  • Method Details

    • getId

      public String getId()
      Description copied from interface: McpTool
      Gets the unique identifier for this tool.
      Specified by:
      getId in interface McpTool
      Returns:
      the tool ID

    • getName

      public String getName()
      Description copied from interface: McpTool
      Gets the display name for this tool.
      Specified by:
      getName in interface McpTool
      Returns:
      the tool name

    • getVersion

      public String getVersion()
      Description copied from interface: McpTool
      Gets the version of this tool.
      Specified by:
      getVersion in interface McpTool
      Returns:
      the tool version

    • getTitle

      public String getTitle()
      Description copied from interface: McpTool
      Gets the title associated with this tool.
      Specified by:
      getTitle in interface McpTool
      Returns:
      the tool title

    • getAnnotation

      public io.modelcontextprotocol.spec.McpSchema.ToolAnnotations getAnnotation()
      Description copied from interface: McpTool
      Gets the tool annotations. By default, readOnly, hidden, idempotent, openWorld are true while destructive and returnDirect are false.
      Specified by:
      getAnnotation in interface McpTool
      Returns:
      McpSchema.ToolAnnotations

    • getDescription

      public String getDescription()
      Description copied from interface: McpTool
      Gets the description for this tool.
      Specified by:
      getDescription in interface McpTool
      Returns:
      the tool description

    • isAvailable

      public boolean isAvailable()
      Description copied from interface: McpTool
      Checks if the tool is available in the current environment.
      Specified by:
      isAvailable in interface McpTool
      Returns:
      true if the tool is available, false otherwise

    • getRequiredContexts

      public List<String> getRequiredContexts()
      Description copied from interface: McpTool
      Gets the contexts that this tool requires.
      Specified by:
      getRequiredContexts in interface McpTool
      Returns:
      a list of required context IDs

    • getParameters

      public List<ToolParameter> getParameters()
      Description copied from interface: McpTool
      Gets the supported parameters for this tool.
      Specified by:
      getParameters in interface McpTool
      Returns:
      a list of parameter descriptions

    • execute

      public ToolResult execute(Map<String,Object> params) throws McpToolException
      Description copied from interface: McpTool
      Executes the tool with the provided parameters.
      Specified by:
      execute in interface McpTool
      Parameters:
      params - the parameters to use
      Returns:
      the result of the execution
      Throws:
      McpToolException - if the tool execution fails

    • getBerResultSchemaJson

      public static String getBerResultSchemaJson()
      Returns the JSON schema string describing the BER node output format.
      Returns:
      JSON Schema (Draft 2020-12) string for BER_RESULT_SCHEMA_RESOURCE_URI