McpResource

mcp.schema.McpResource
See theMcpResource companion trait
object McpResource

Attributes

Companion
trait
Source
McpResource.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final case class Static(uri: String, name: String, description: Option[String], mimeType: Option[String], annotations: Annotations) extends McpResource

A known resource that the server is capable of reading.

A known resource that the server is capable of reading.

Value parameters

annotations

Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.

description

A description of what this resource represents. 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.

mimeType

The MIME type of this resource, if known.

name

A human-readable name for this resource. This can be used by clients to populate UI elements.

uri

the URI of the resource.

Attributes

Companion
object
Source
McpResource.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait McpResource
class Object
trait Matchable
class Any
Show all
object Static

Attributes

Companion
class
Source
McpResource.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Static.type
final case class Template(uriTemplate: String, name: String, description: Option[String], mimeType: Option[String], annotations: Annotations) extends McpResource

Resource templates allow servers to expose parameterized resources using URI templates.

Resource templates allow servers to expose parameterized resources using URI templates.

Value parameters

annotations

Optional annotations for the client. The client can use annotations to inform how objects are used or displayed.

description

A description of what this resource represents. 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.

mimeType

The MIME type of this resource, if known.

name

A human-readable name for this resource. This can be used by clients to populate UI elements.

uriTemplate

A URI template that can be used to generate URIs for this resource.

Attributes

See also
Companion
object
Source
McpResource.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait McpResource
class Object
trait Matchable
class Any
Show all
object Template

Attributes

Companion
class
Source
McpResource.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Template.type

Value members

Concrete methods

def static(uri: String, name: String, description: Option[String], mimeType: Option[String], annotations: Annotations): Static

Attributes

Source
McpResource.scala
def template(uriTemplate: String, name: String, description: Option[String], mimeType: Option[String], annotations: Annotations): Template

Attributes

Source
McpResource.scala