class ActionController::MCPServer::Description

• ActionController::MCPServer::Description
• Reference
• Object

Overview

the toolboxes available to MCP clients, typically saved as mcp.yml

Included Modules

• JSON::Serializable
• YAML::Serializable

Extended Modules

• JSON::Schema

Defined in:

action-controller/mcp/description.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(toolboxes : Array(ActionController::MCPServer::Toolbox) = [] of Toolbox, endpoints : Array(ActionController::MCPServer::Endpoint) = [] of Endpoint)

Instance Method Summary

• #composition_id : String | Nil

  Detects descriptions generated for a different application composition.

• #composition_id=(composition_id : String | Nil)

  Detects descriptions generated for a different application composition.

• #endpoint?(path : String) : Endpoint | Nil

  the endpoint served at the path template, i.e.

• #endpoints : Array(Endpoint)

  controllers served as their own MCP server, see ActionController::MCP

• #prompt?(name : String) : Tuple(Toolbox, Prompt) | Nil

  returns the prompt and the toolbox it belongs to

• #prompts? : Bool
• #resource?(uri : String) : Tuple(Tool, Hash(String, String)) | Nil

  the resource tool whose template matches the URI, and the template variables

• #resource_tools : Array(Tool)

  the tools that are readable as resource templates, the most specific templates first

• #root_prompts : Array(Prompt)

  the prompts available without opening a toolbox

• #root_tools : Array(Tool)

  the tools available without opening a toolbox

• #subscriptions? : Bool

  true if any resource template can be subscribed to

• #tool?(name : String) : Tuple(Toolbox, Tool) | Nil

  returns the tool and the toolbox it belongs to

• #toolbox?(name : String) : Toolbox | Nil
• #toolboxes : Array(Toolbox)
• #ui? : Bool

  true if any tool renders an MCP Apps card

Constructor Detail

Instance Method Detail