plugins

Documentation

Index

• Variables

Variables

var AddPluginServerForm = Type("AddPluginServerForm", func() {
	Required("plugin_id", "toolset_id", "display_name")

	Attribute("plugin_id", String, func() {
		Format(FormatUUID)
	})
	Attribute("toolset_id", String, func() {
		Description("Gram toolset ID for the MCP server.")
		Format(FormatUUID)
	})
	Attribute("display_name", String, "Display name for the server.")
	Attribute("policy", String, func() {
		Enum("required", "optional")
		Default("required")
	})
	Attribute("sort_order", Int32, func() {
		Default(0)
	})
})

var CreatePluginForm = Type("CreatePluginForm", func() {
	Required("name")

	Attribute("name", String, "Display name for the plugin.")
	Attribute("slug", String, "Optional URL-safe identifier. Auto-generated from name if omitted.")
	Attribute("description", String, "Optional description.")
})

var ListPluginsResult = Type("ListPluginsResult", func() {
	Required("plugins")
	Attribute("plugins", ArrayOf(PluginModel), "The plugins in the organization.")
})

var PluginAssignmentModel = Type("PluginAssignment", func() {
	Required("id", "principal_urn", "created_at")

	Attribute("id", String, func() {
		Description("Unique assignment identifier.")
		Format(FormatUUID)
	})
	Attribute("principal_urn", String, "Principal URN (e.g. role:engineering, user:id, or *).")
	Attribute("created_at", String, func() {
		Format(FormatDateTime)
	})
})

PluginAssignmentModel represents a role or user assignment for a plugin.

var PluginModel = Type("Plugin", func() {
	Required("id", "name", "slug", "created_at", "updated_at")

	Attribute("id", String, func() {
		Description("Unique plugin identifier.")
		Format(FormatUUID)
	})
	Attribute("name", String, "Display name.")
	Attribute("slug", String, "URL-safe identifier, unique per org.")
	Attribute("description", String, "Optional description.")
	Attribute("server_count", Int64, "Number of active servers in this plugin.")
	Attribute("assignment_count", Int64, "Number of role/user assignments.")
	Attribute("servers", ArrayOf(PluginServerModel), "Servers included in this plugin.")
	Attribute("assignments", ArrayOf(PluginAssignmentModel), "Role/user assignments.")
	Attribute("created_at", String, func() {
		Format(FormatDateTime)
	})
	Attribute("updated_at", String, func() {
		Format(FormatDateTime)
	})
})

PluginModel is the full plugin representation.

var PluginServerModel = Type("PluginServer", func() {
	Required("id", "toolset_id", "display_name", "policy", "sort_order", "created_at")

	Attribute("id", String, func() {
		Description("Unique plugin server identifier.")
		Format(FormatUUID)
	})
	Attribute("toolset_id", String, func() {
		Description("Gram toolset ID.")
		Format(FormatUUID)
	})
	Attribute("display_name", String, "Display name shown in generated plugin config.")
	Attribute("policy", String, func() {
		Description("Whether this server is required or optional.")
		Enum("required", "optional")
	})
	Attribute("sort_order", Int32, "Ordering within the plugin.")
	Attribute("created_at", String, func() {
		Format(FormatDateTime)
	})
})

PluginServerModel represents a toolset-backed MCP server included in a plugin.

var PublishPluginsResult = Type("PublishPluginsResult", func() {
	Required("repo_url")
	Attribute("repo_url", String, "The URL of the published GitHub repository.")
})

var PublishStatusResult = Type("PublishStatusResult", func() {
	Required("configured", "connected")

	Attribute("configured", Boolean, "Whether GitHub publishing is configured on the server.")
	Attribute("connected", Boolean, "Whether this project has a GitHub connection.")
	Attribute("repo_owner", String, "GitHub repo owner, if connected.")
	Attribute("repo_name", String, "GitHub repo name, if connected.")
	Attribute("repo_url", String, "Full GitHub repository URL, if connected.")
	Attribute("marketplace_url", String, "Git-based Claude Code marketplace URL — the value to pass to `/plugin marketplace add` or set as the source URL in `extraKnownMarketplaces`. Present once a marketplace token has been minted, which happens automatically on the first publish.")
})

var SetPluginAssignmentsForm = Type("SetPluginAssignmentsForm", func() {
	Required("plugin_id", "principal_urns")

	Attribute("plugin_id", String, func() {
		Format(FormatUUID)
	})
	Attribute("principal_urns", ArrayOf(String), "List of principal URNs to assign.")
})

var UpdatePluginForm = Type("UpdatePluginForm", func() {
	Required("id", "name", "slug")

	Attribute("id", String, func() {
		Format(FormatUUID)
	})
	Attribute("name", String, "Updated display name.")
	Attribute("slug", String, "Updated slug.")
	Attribute("description", String, "Updated description.")
})

var UpdatePluginServerForm = Type("UpdatePluginServerForm", func() {
	Required("id", "plugin_id", "display_name")

	Attribute("id", String, func() {
		Format(FormatUUID)
	})
	Attribute("plugin_id", String, func() {
		Format(FormatUUID)
	})
	Attribute("display_name", String)
	Attribute("policy", String, func() {
		Enum("required", "optional")
		Default("required")
	})
	Attribute("sort_order", Int32, func() {
		Default(0)
	})
})