class
MCProtocol::ResourceTemplate
- MCProtocol::ResourceTemplate
- Reference
- Object
Overview
A template description for resources available on the server.
Included Modules
- JSON::Serializable
Defined in:
mcprotocol/resource_template.crConstructors
- .new(name : String, uriTemplate : URI, annotations : ResourceTemplateAnnotations | Nil = Nil, description : String | Nil = Nil, mimeType : String | Nil = Nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
- #annotations : ResourceTemplateAnnotations | Nil
-
#description : String | Nil
A description of what this template is for.
-
#mimeType : String | Nil
The MIME type for all resources that match this template.
-
#name : String
A human-readable name for the type of resource this template refers to.
-
#uriTemplate : URI
A URI template (according to RFC 6570) that can be used to construct resource URIs.
Constructor Detail
Instance Method Detail
A description of what this template is for.
This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.
The MIME type for all resources that match this template. This should only be included if all resources matching this template have the same type.
A human-readable name for the type of resource this template refers to.
This can be used by clients to populate UI elements.
A URI template (according to RFC 6570) that can be used to construct resource URIs.