Interface ApiMethod

One advertised method, as the host generated it from its gate table.

interface ApiMethod {
    capability: string;
    name: string;
    paramsSchema?: Record<string, unknown>;
    stream?: boolean;
}

Properties

capability name paramsSchema? stream?

Properties

capability

capability: string

The capability this method requires (already held — it's in your catalog).

name

name: string

Catalog name, protocol- stripped — e.g. spaces:invite, contribute:run.

OptionalparamsSchema

paramsSchema?: Record<string, unknown>

JSON Schema for the method's single object argument, when the host declares one. Self-describes the call so a catalog-as-tools bridge (an embedded agent) can advertise the real param shape — e.g. that authoring:typecheck takes a nested { files: [{ path, content }] } array — instead of a permissive "any object". Absent for methods the host advertises without a schema.

Optionalstream

stream?: boolean

True when the method STREAMS (use invokeStream) vs. single-reply.

Settings

Member Visibility

On This Page

Properties