Struct ActionDoc 

pub struct ActionDoc {

    pub service: String,
    pub action: String,
    pub description: String,
    pub destructive: bool,
    pub requires_admin: bool,
    pub cost: String,
    pub required_scope: Option<String>,
    pub params: Vec<ParamDoc>,
    pub returns: String,
    pub surface_availability: SurfaceAvailability,
    pub auth_posture: String,
    pub mcp_only_exception: Option<String>,
    pub cli: Option<CliDoc>,
}

Serializable, catalog-facing documentation for a single action.

Fields

service: String

Owning service name (always "soma").

action: String

Action name.

description: String

Human-readable description of the action.

destructive: bool

Whether the action is destructive.

requires_admin: bool

Whether the action requires admin privileges.

cost: String

Advertised cost tier label.

required_scope: Option<String>

Scope required to invoke the action, or None if public.

params: Vec<ParamDoc>

Parameter documentation.

returns: String

Name of the returned result type.

surface_availability: SurfaceAvailability

Which surfaces expose the action.

auth_posture: String

Human-readable summary of the action’s auth requirements.

mcp_only_exception: Option<String>

Explanation of why the action is MCP-only, when applicable.

cli: Option<CliDoc>

CLI documentation for the action, if it has a CLI surface.

Trait Implementations

impl Clone for ActionDoc

fn clone(&self) -> ActionDoc

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActionDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ActionDoc

fn eq(&self, other: &ActionDoc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ActionDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ActionDoc

impl StructuralPartialEq for ActionDoc