mcp-scala-schema
0.1.0-alpha1
API
Generated with
mcp-scala-schema/mcp.schema/McpSchema

McpSchema

mcp.schema.McpSchema
See theMcpSchema companion class
object McpSchema

Attributes

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

Members list

Type members

Classlikes

sealed trait Annotated

Base for objects that include optional annotations for the client. The client can use annotations to inform how objects are used or displayed

Base for objects that include optional annotations for the client. The client can use annotations to inform how objects are used or displayed

Attributes

Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
final case class Annotations(audience: List[Role], priority: Option[Double])

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

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

Value parameters

audience

Describes who the intended customer of this object or data is. It can include multiple entries to indicate content useful for multiple audiences (e.g., ["user", "assistant"]).

priority

Describes how important this data is for operating the server. A value of 1 means "most important," and indicates that the data is effectively required, while 0 means "least important," and indicates that the data is entirely optional. It is a number between 0 and 1.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class BlobResourceContents(uri: String, mimeType: String, blob: String) extends ResourceContents

Binary contents of a resource.

Binary contents of a resource.

Value parameters

blob

a base64-encoded string representing the binary data of the resource. This must only be set if the resource can actually be represented as binary data (not text).

mimeType

the MIME type of this resource.

uri

the URI of this resource.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CallToolRequest(name: String, arguments: Json) extends Request

Used by the client to call a tool provided by the server.

Used by the client to call a tool provided by the server.

Value parameters

arguments

Arguments to pass to the tool. These must conform to the tool's input schema.

name

The name of the tool to call. This must match a tool name from tools/list.

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Request
class Object
trait Matchable
class Any
Show all
object CallToolRequest

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CallToolResult(content: List[Content], isError: Boolean)

The server's response to a tools/call request from the client.

The server's response to a tools/call request from the client.

Value parameters

content

A list of content items representing the tool's output. Each item can be text, an image, or an embedded resource.

isError

If true, indicates that the tool execution failed and the content contains error information. If false or absent, indicates successful execution.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ClientCapabilities(experimental: Option[Map[String, Json]], roots: Option[RootCapabilities], sampling: Option[Sampling])

Clients can implement additional features to enrich connected MCP servers with additional capabilities. These capabilities can be used to extend the functionality of the server, or to provide additional information to the server about the client's capabilities.

Clients can implement additional features to enrich connected MCP servers with additional capabilities. These capabilities can be used to extend the functionality of the server, or to provide additional information to the server about the client's capabilities.

Value parameters

experimental

WIP

roots

define the boundaries of where servers can operate within the filesystem, allowing them to understand which directories and files they have access to.

sampling

Provides a standardized way for servers to request LLM sampling (“completions” or “generations”) from language models via clients.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CompleteArgument(name: String, value: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CompleteCompletion(values: List[String], total: Int, hasMore: Boolean)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CompleteRequest(ref: PromptOrResourceReference, argument: CompleteArgument) extends Request

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Request
class Object
trait Matchable
class Any
Show all
object CompleteRequest

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CompleteResult(completion: CompleteCompletion)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Content

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Content.type
sealed trait Content

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ImageContent
class TextContent
enum ContextInclusionStrategy

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ContextInclusionStrategy

Attributes

Companion
enum
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CreateMessageRequest(messages: List[SamplingMessage], modelPreferences: ModelPreferences, systemPrompt: Option[String], includeContext: ContextInclusionStrategy, temperature: Double, maxTokens: Int, stopSequences: List[String], metadata: Map[String, Json]) extends Request

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Request
class Object
trait Matchable
class Any
Show all
object CreateMessageRequest

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CreateMessageResult(role: Role, content: Content, model: String, stopReason: StopReason)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class EmbeddedResource(audience: List[Role], priority: Double, resource: ResourceContents) extends Content

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Content
class Object
trait Matchable
class Any
Show all
object EmbeddedResource

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ErrorCodes

Standard error codes used in MCP JSON-RPC responses.

Standard error codes used in MCP JSON-RPC responses.

Attributes

Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ErrorCodes.type
final case class GetPromptRequest(name: String, arguments: Map[String, Json]) extends Request

Used by the client to get a prompt provided by the server.

Used by the client to get a prompt provided by the server.

Value parameters

arguments

Arguments to use for templating the prompt.

name

The name of the prompt or prompt template.

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Request
class Object
trait Matchable
class Any
Show all
object GetPromptRequest

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class GetPromptResult(description: Option[String], messages: List[PromptMessage])

The server's response to a prompts/get request from the client.

The server's response to a prompts/get request from the client.

Value parameters

description

An optional description for the prompt.

messages

A list of messages to display as part of the prompt.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ImageContent(audience: List[Role], priority: Double, data: String, mimeType: String) extends Content

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Content
class Object
trait Matchable
class Any
Show all
object ImageContent

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Implementation(name: String, version: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InitializeRequest(protocolVersion: String, capabilities: ClientCapabilities, clientInfo: Implementation) extends Request

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Request
class Object
trait Matchable
class Any
Show all
object InitializeRequest

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InitializeResult(protocolVersion: String, capabilities: ServerCapabilities, serverInfo: Implementation, instructions: Option[String])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JSONRPCBatch(jsonrpc: String, requests: List[JSONRPCMessage]) extends JSONRPCMessage

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JSONRPCError(code: Int, message: String, data: Option[Json])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object JSONRPCMessage

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait JSONRPCMessage

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class JSONRPCBatch
final case class JSONRPCNotification(jsonrpc: String, method: Method, params: Option[Json]) extends JSONRPCMessage

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JSONRPCRequest(jsonrpc: String, method: Method, id: Id, params: Option[Json]) extends JSONRPCMessage

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class JSONRPCResponse(jsonrpc: String, id: Id, result: Option[Json], error: Option[JSONRPCError]) extends JSONRPCMessage

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListPromptsResult(prompts: List[Prompt], nextCursor: Option[String])

The server's response to a prompts/list request from the client.

The server's response to a prompts/list request from the client.

Value parameters

nextCursor

An optional cursor for pagination. If present, indicates there are more prompts available.

prompts

A list of prompts that the server provides.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListResourceTemplatesResult(resourceTemplates: List[Resource], nextCursor: Option[String])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListResourcesResult(resources: List[Resource], nextCursor: Option[String])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListRootsResult(roots: List[Root])

The client's response to a roots/list request from the server. This result contains an array of Root objects, each representing a root directory or file that the server can operate on.

The client's response to a roots/list request from the server. This result contains an array of Root objects, each representing a root directory or file that the server can operate on.

Value parameters

roots

An array of Root objects, each representing a root directory or file that the server can operate on.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ListToolsResult(tools: List[ToolSchema], nextCursor: Option[String])

The server's response to a tools/list request from the client.

The server's response to a tools/list request from the client.

Value parameters

nextCursor

An optional cursor for pagination. If present, indicates there are more tools available.

tools

A list of tools that the server provides.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class LoggingCapabilities()

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum LoggingLevel(val code: Int, val name: String)

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LoggingLevel

Attributes

Companion
enum
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class LoggingMessageNotification(level: LoggingLevel, logger: String, data: String)

The Model Context Protocol (MCP) provides a standardized way for servers to send structured log messages to clients. Clients can control logging verbosity by setting minimum log levels, with servers sending notifications containing severity levels, optional logger names, and arbitrary JSON-serializable data.

The Model Context Protocol (MCP) provides a standardized way for servers to send structured log messages to clients. Clients can control logging verbosity by setting minimum log levels, with servers sending notifications containing severity levels, optional logger names, and arbitrary JSON-serializable data.

Value parameters

data

JSON-serializable logging data.

level

The severity levels. The mimimum log level is set by the client.

logger

The logger that generated the message.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Method

Attributes

Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Method.type
final case class ModelHint(name: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ModelHint.type
final case class ModelPreferences(hints: List[ModelHint], costPriority: Double, speedPriority: Double, intelligencePriority: Double)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PaginatedRequest(cursor: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PaginatedResult(nextCursor: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ProgressNotification(progressToken: String, progress: Double, total: Double)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Prompt(name: String, description: String, arguments: List[PromptArgument])

A prompt or prompt template that the server offers.

A prompt or prompt template that the server offers.

Value parameters

arguments

A list of arguments to use for templating the prompt.

description

An optional description of what this prompt provides.

name

The name of the prompt or prompt template.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Prompt.type
final case class PromptArgument(name: String, description: String, required: Boolean)

Describes an argument that a prompt can accept.

Describes an argument that a prompt can accept.

Value parameters

description

A human-readable description of the argument.

name

The name of the argument.

required

Whether this argument must be provided.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PromptCapabilities(listChanged: Boolean)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PromptHandler[F[_]](prompt: Prompt, handler: GetPromptRequest => F[GetPromptResult])

Attributes

Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class PromptMessage(role: Role, content: Content)

Describes a message returned as part of a prompt.

Describes a message returned as part of a prompt.

This is similar to SamplingMessage, but also supports the embedding of resources from the MCP server.

Value parameters

content

The content of the message of type Content.

role

The sender or recipient of messages and data in a conversation.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object PromptOrResourceReference

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait PromptOrResourceReference

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class PromptReference(`type`: String, uri: String) extends PromptOrResourceReference

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ReadResourceRequest(uri: String)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ReadResourceResult(contents: List[ResourceContents])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Request

Attributes

Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Resource

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Resource.type
trait Resource

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class ResourceCapabilities(subscribe: Option[Boolean], listChanged: Option[Boolean])

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ResourceContents

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ResourceContents

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ResourceHandler[F[_]]

Attributes

Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
final case class ResourceReference(`type`: String, uri: String) extends PromptOrResourceReference

Attributes

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

Attributes

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

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
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Resource
class Object
trait Matchable
class Any
Show all
object ResourceTemplate

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum Role

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Role

Attributes

Companion
enum
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Role.type
final case class Root(uri: String, name: Option[String])

Represents a root directory or file that the server can operate on.

Represents a root directory or file that the server can operate on.

Value parameters

name

An optional name for the root. This can be used to provide a human-readable identifier for the root, which may be useful for display purposes or for referencing the root in other parts of the application.

uri

The URI identifying the root. This must start with file:// for now. This restriction may be relaxed in future versions of the protocol to allow other URI schemes.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Root.type
final case class RootCapabilities(listChanged: Boolean)

Roots define the boundaries of where servers can operate within the filesystem, allowing them to understand which directories and files they have access to. Servers can request the list of roots from supporting clients and receive notifications when that list changes.

Roots define the boundaries of where servers can operate within the filesystem, allowing them to understand which directories and files they have access to. Servers can request the list of roots from supporting clients and receive notifications when that list changes.

Value parameters

listChanged

Whether the client would send notification about roots has changed since the last time the server checked.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Sampling()

Provides a standardized way for servers to request LLM sampling ("completions" or "generations") from language models via clients. This flow allows clients to maintain control over model access, selection, and permissions while enabling servers to leverage AI capabilities—with no server API keys necessary. Servers can request text or image-based interactions and optionally include context from MCP servers in their prompts.

Provides a standardized way for servers to request LLM sampling ("completions" or "generations") from language models via clients. This flow allows clients to maintain control over model access, selection, and permissions while enabling servers to leverage AI capabilities—with no server API keys necessary. Servers can request text or image-based interactions and optionally include context from MCP servers in their prompts.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Sampling.type
final case class SamplingMessage(role: Role, content: Content)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ServerCapabilities(prompt: PromptCapabilities, resources: ResourceCapabilities, tools: ToolCapabilities)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class StaticResource(uri: String, name: String, description: Option[String], mimeType: Option[String], annotations: Annotations) extends Resource

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
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Resource
class Object
trait Matchable
class Any
Show all
object StaticResource

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum StopReason

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StopReason

Attributes

Companion
enum
Source
McpSchema.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
StopReason.type
final case class SubscribeRequest(uri: String)

Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.

Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.

Value parameters

uri

the URI of the resource to subscribe to. The URI can use any protocol; it is up to the server how to interpret it.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TextContent(audience: Option[List[Role]], priority: Option[Double], text: String) extends Content

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Content
class Object
trait Matchable
class Any
Show all
object TextContent

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TextResourceContents(uri: String, mimeType: String, text: String) extends ResourceContents

Text contents of a resource.

Text contents of a resource.

Value parameters

mimeType

the MIME type of this resource.

text

the text of the resource. This must only be set if the resource can actually be represented as text (not binary data).

uri

the URI of this resource.

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Tool[F[_], T](name: String, description: String, execute: T => F[CallToolResult])(implicit evidence$1: JsonSchema[T], evidence$2: Decoder[T]) extends ToolSchema

Represents a tool that the server provides. Tools enable servers to expose executable functionality to the system. Through these tools, you can interact with external systems, perform computations, and take actions in the real world.

Represents a tool that the server provides. Tools enable servers to expose executable functionality to the system. Through these tools, you can interact with external systems, perform computations, and take actions in the real world.

Value parameters

description

A human-readable description of what the tool does. This can be used by clients to improve the LLM's understanding of available tools.

name

A unique identifier for the tool. This name is used when calling the tool.

Attributes

Source
McpSchema.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait ToolSchema
class Object
trait Matchable
class Any
Show all
final case class ToolCapabilities(listChanged: Boolean)

Attributes

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

Attributes

Companion
class
Source
McpSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ToolSchema

Attributes

Companion
trait
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ToolSchema.type
trait ToolSchema

Attributes

Companion
object
Source
McpSchema.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Tool[F, T]
class Static
final case class UnsubscribeRequest(uri: String)

Attributes

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

Attributes

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

Types

opaque type Method

Attributes

Source
McpSchema.scala

Value members

Concrete fields

val JSONRPC_VERSION: String

Attributes

Source
McpSchema.scala
val METHOD_INITIALIZE: Method

Attributes

Source
McpSchema.scala
val METHOD_PING: Method

Attributes

Source
McpSchema.scala
val METHOD_PROMPT_GET: Method

Attributes

Source
McpSchema.scala
val METHOD_PROMPT_LIST: Method

Attributes

Source
McpSchema.scala
val METHOD_ROOTS_LIST: Method

Attributes

Source
McpSchema.scala
val METHOD_TOOLS_CALL: Method

Attributes

Source
McpSchema.scala
val METHOD_TOOLS_LIST: Method

Attributes

Source
McpSchema.scala
Generated with