externalmcp

Documentation

Index

• Variables

Variables

var ExternalMCPRemote = Type("ExternalMCPRemote", func() {
	Meta("struct:pkg:path", "types")

	Description("A remote endpoint for an MCP server")

	Attribute("url", String, "URL of the remote endpoint", func() {
		Format(FormatURI)
	})
	Attribute("transport_type", String, "Transport type (sse or streamable-http)", func() {
		Enum("sse", "streamable-http")
	})
	Attribute("headers", ArrayOf(ExternalMCPRemoteHeader), "HTTP headers the MCP client should collect and send when connecting to this remote")
	Attribute("variables", MapOf(String, ExternalMCPRemoteVariable), "URL template variables for this remote endpoint")

	Required("url", "transport_type")
})

var ExternalMCPRemoteHeader = Type("ExternalMCPRemoteHeader", func() {
	Meta("struct:pkg:path", "types")

	Description("A header requirement for a remote MCP server")

	Attribute("name", String, "Header name")
	Attribute("description", String, "Description of the header")
	Attribute("is_secret", Boolean, "Whether this header value should be treated as secret")
	Attribute("is_required", Boolean, "Whether this header is required")
	Attribute("placeholder", String, "Placeholder value to show when collecting this header")

	Required("name")
})

var ExternalMCPRemoteVariable = Type("ExternalMCPRemoteVariable", func() {
	Meta("struct:pkg:path", "types")

	Description("A URL template variable for a remote MCP server")

	Attribute("description", String, "Description of the variable")
	Attribute("is_required", Boolean, "Whether this variable is required")
	Attribute("is_secret", Boolean, "Whether this variable value should be treated as secret")
	Attribute("default", String, "Default value for the variable")
	Attribute("choices", ArrayOf(String), "Allowed values for the variable")
})

var ExternalMCPServer = Type("ExternalMCPServer", func() {
	Meta("struct:pkg:path", "types")

	Description("An MCP server from an external registry")

	Attribute("registry_specifier", String, "Server specifier used to look up in the registry (e.g., 'io.github.user/server')", func() {
		Example("io.modelcontextprotocol.anonymous/exa")
	})
	Attribute("version", String, "Semantic version of the server", func() {
		Example("1.0.0")
	})
	Attribute("description", String, "Description of what the server does")
	Attribute("toolset_id", String, "ID of the attached toolset when this server is listed from a Collection", func() {
		Format(FormatUUID)
	})
	Attribute("registry_id", String, "ID of the external MCP registry this server came from", func() {
		Format(FormatUUID)
	})
	Attribute("organization_mcp_collection_registry_id", String, "ID of the internal collection registry this server came from", func() {
		Format(FormatUUID)
	})
	Attribute("title", String, "Display name for the server")
	Attribute("icon_url", String, "URL to the server's icon", func() {
		Format(FormatURI)
	})
	Attribute("meta", Any, "Opaque metadata from the registry")
	Attribute("tools", ArrayOf(ExternalMCPTool), "Tools available on the server")
	Attribute("remotes", ArrayOf(ExternalMCPRemote), "Available remote endpoints for the server")

	Required("registry_specifier", "version", "description")
})

var ExternalMCPTool = Type("ExternalMCPTool", func() {
	Meta("struct:pkg:path", "types")

	Attribute("name", String, "Name of the tool")
	Attribute("description", String, "Description of the tool")
	Attribute("input_schema", Any, "Input schema for the tool")
	Attribute("annotations", Any, "Annotations for the tool")
})

var MCPRegistry = Type("MCPRegistry", func() {
	Meta("struct:pkg:path", "types")

	Description("An MCP registry")

	Attribute("id", String, "Registry ID", func() {
		Format(FormatUUID)
	})
	Attribute("name", String, "Display name for the registry")
	Attribute("url", String, "URL of the registry")

	Required("id", "name", "url")
})