SharedOS API / @aicoo/sharedos-contracts
@aicoo/sharedos-contracts
Strict, JSON-safe SharedOS protocol schemas and TypeScript types.
npm install @aicoo/sharedos-contracts@next
Use this package for addresses, capabilities, messages, resources, tools, runtime manifests/events/outcomes, execution results, and HTTP wire contracts. External boundaries should parse untrusted values with the exported schemas rather than relying on type casts.
Tool definitions include a logical namespace, source, read/write catalog class,
and exact capability requirement. Access contexts carry the trusted effective
namespace selection; ToolNamespaceUpdateSchema defines portable, idempotent
enable/disable patches.
SharedOS is currently an 0.x prerelease.
Interfaces
JsonObject
Defined in: json.ts:4
Indexable
[
key:string]:JsonValue
Type Aliases
AccessContext
AccessContext =
z.infer<typeofAccessContextSchema>>
Defined in: access.ts:24
Address
Address =
z.infer<typeofAddressSchema>>
Defined in: address.ts:33
AgentAddress
AgentAddress =
z.infer<typeofAgentAddressSchema>>
Defined in: address.ts:13
AuthorizationDecision
AuthorizationDecision =
z.infer<typeofAuthorizationDecisionSchema>>
Defined in: access.ts:36
Capability
Capability =
z.infer<typeofCapabilitySchema>>
Defined in: capability.ts:46
CapabilityConstraints
CapabilityConstraints =
z.infer<typeofCapabilityConstraintsSchema>>
Defined in: capability.ts:71
CapabilityGrant
CapabilityGrant =
z.infer<typeofCapabilityGrantSchema>>
Defined in: capability.ts:105
CapabilityRequest
CapabilityRequest =
z.infer<typeofCapabilityRequestSchema>>
Defined in: capability.ts:88
CapabilityRequirement
CapabilityRequirement =
z.infer<typeofCapabilityRequirementSchema>>
Defined in: capability.ts:115
EnabledToolNamespaces
EnabledToolNamespaces =
z.infer<typeofEnabledToolNamespacesSchema>>
Defined in: tool.ts:34
ExecutionEvent
ExecutionEvent =
z.infer<typeofExecutionEventSchema>>
Defined in: execution.ts:55
ExecutionOptions
ExecutionOptions =
z.infer<typeofExecutionOptionsSchema>>
Defined in: execution.ts:22
ExecutionRequest
ExecutionRequest =
z.infer<typeofExecutionRequestSchema>>
Defined in: execution.ts:39
ExecutionResult
ExecutionResult =
z.infer<typeofExecutionResultSchema>>
Defined in: execution.ts:86
GroupAddress
GroupAddress =
z.infer<typeofGroupAddressSchema>>
Defined in: address.ts:18
HumanAddress
HumanAddress =
z.infer<typeofHumanAddressSchema>>
Defined in: address.ts:8
Identifier
Identifier =
z.infer<typeofIdentifierSchema>>
Defined in: common.ts:9
JsonArray
JsonArray =
JsonValue[]
Defined in: json.ts:7
JsonPrimitive
JsonPrimitive =
string|number|boolean|null
Defined in: json.ts:3
JsonValue
JsonValue =
JsonPrimitive|JsonObject|JsonArray
Defined in: json.ts:8
MessageDeliveryResult
MessageDeliveryResult =
z.infer<typeofMessageDeliveryResultSchema>>
Defined in: message.ts:60
MessageEnvelope
MessageEnvelope =
z.infer<typeofMessageEnvelopeSchema>>
Defined in: message.ts:38
MessageProvenance
MessageProvenance =
z.infer<typeofMessageProvenanceSchema>>
Defined in: message.ts:16
ProtocolError
ProtocolError =
z.infer<typeofProtocolErrorSchema>>
Defined in: protocol-error.ts:16
ProtocolVersion
ProtocolVersion =
z.infer<typeofProtocolVersionSchema>>
Defined in: common.ts:5
RemoteExecutionRequest
RemoteExecutionRequest =
z.infer<typeofRemoteExecutionRequestSchema>>
Defined in: http.ts:18
RemoteResourceOperation
RemoteResourceOperation =
z.infer<typeofRemoteResourceOperationSchema>>
Defined in: http.ts:11
ResourceOperation
ResourceOperation =
z.infer<typeofResourceOperationSchema>>
Defined in: resource.ts:21
ResourceRef
ResourceRef =
z.infer<typeofResourceRefSchema>>
Defined in: capability.ts:35
ResourceResult
ResourceResult =
z.infer<typeofResourceResultSchema>>
Defined in: resource.ts:44
RuntimeEvent
RuntimeEvent =
z.infer<typeofRuntimeEventSchema>>
Defined in: runtime.ts:27
RuntimeManifest
RuntimeManifest =
z.infer<typeofRuntimeManifestSchema>>
Defined in: runtime.ts:17
RuntimeTurnOutcome
RuntimeTurnOutcome =
z.infer<typeofRuntimeTurnOutcomeSchema>>
Defined in: runtime.ts:45
ServiceAddress
ServiceAddress =
z.infer<typeofServiceAddressSchema>>
Defined in: address.ts:23
SharedOSApiErrorResponse
SharedOSApiErrorResponse =
z.infer<typeofSharedOSApiErrorResponseSchema>>
Defined in: http.ts:39
SharedOSHealth
SharedOSHealth =
z.infer<typeofSharedOSHealthSchema>>
Defined in: http.ts:26
Timestamp
Timestamp =
z.infer<typeofTimestampSchema>>
Defined in: common.ts:13
ToolAnnotations
ToolAnnotations =
z.infer<typeofToolAnnotationsSchema>>
Defined in: tool.ts:79
ToolCall
ToolCall =
z.infer<typeofToolCallSchema>>
Defined in: tool.ts:182
ToolDefinition
ToolDefinition =
z.infer<typeofToolDefinitionSchema>>
Defined in: tool.ts:113
ToolNamespace
ToolNamespace =
z.infer<typeofToolNamespaceSchema>>
Defined in: tool.ts:10
ToolNamespaceCatalog
ToolNamespaceCatalog =
z.infer<typeofToolNamespaceCatalogSchema>>
Defined in: tool.ts:170
ToolNamespaceDescriptor
ToolNamespaceDescriptor =
z.infer<typeofToolNamespaceDescriptorSchema>>
Defined in: tool.ts:132
ToolNamespaceUpdate
ToolNamespaceUpdate =
z.infer<typeofToolNamespaceUpdateSchema>>
Defined in: tool.ts:69
ToolReadWrite
ToolReadWrite =
z.infer<typeofToolReadWriteSchema>>
Defined in: tool.ts:21
ToolResult
ToolResult =
z.infer<typeofToolResultSchema>>
Defined in: tool.ts:206
ToolSource
ToolSource =
z.infer<typeofToolSourceSchema>>
Defined in: tool.ts:17
Variables
AccessContextSchema
constAccessContextSchema:ZodObject<{actor:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;authority:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;enabledToolNamespaces:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>;grants:ZodArray<ZodObject<{capabilities:ZodArray<ZodObject<{actions:ZodArray<ZodString,"many">>;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<...>;path:ZodArray<..., ...>; },"strict",ZodTypeAny, {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }, {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }>;scope:ZodEnum<["exact","descendants"]>; },"strict",ZodTypeAny, {actions:string[];resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; };scope:"exact"|"descendants"; }, {actions:string[];resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; };scope:"exact"|"descendants"; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth:ZodOptional<ZodNumber>>;expiresAt:ZodOptional<ZodString>>;maxUses:ZodOptional<ZodNumber>>;notBefore:ZodOptional<ZodString>>;purposes:ZodOptional<ZodArray<ZodString,"many">>>>; },"strict",ZodTypeAny, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>,"many">>;namespaceId:ZodString;now:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }>
Defined in: access.ts:10
All inputs needed for a deterministic permission decision.
AddressSchema
constAddressSchema:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>
Defined in: address.ts:26
A structured protocol address; no string suffix or prefix parsing is needed.
AgentAddressSchema
constAgentAddressSchema:ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>
Defined in: address.ts:10
AuthorizationDecisionSchema
constAuthorizationDecisionSchema:ZodObject<{allowed:ZodBoolean;matchedGrantId:ZodOptional<ZodString>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;reasonCode:ZodString; },"strict",ZodTypeAny, {allowed:boolean;matchedGrantId?:string;metadata?:JsonObject;reasonCode:string; }, {allowed:boolean;matchedGrantId?:string;metadata?:JsonObject;reasonCode:string; }>
Defined in: access.ts:27
A portable explanation of one authorization check.
CapabilityConstraintsSchema
constCapabilityConstraintsSchema:ZodEffects<ZodObject<{delegationDepth:ZodOptional<ZodNumber>>;expiresAt:ZodOptional<ZodString>>;maxUses:ZodOptional<ZodNumber>>;notBefore:ZodOptional<ZodString>>;purposes:ZodOptional<ZodArray<ZodString,"many">>>>; },"strict",ZodTypeAny, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>
Defined in: capability.ts:48
CapabilityGrantSchema
constCapabilityGrantSchema:ZodObject<{capabilities:ZodArray<ZodObject<{actions:ZodArray<ZodString,"many">>;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>;scope:ZodEnum<["exact","descendants"]>; },"strict",ZodTypeAny, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth:ZodOptional<ZodNumber>>;expiresAt:ZodOptional<ZodString>>;maxUses:ZodOptional<ZodNumber>>;notBefore:ZodOptional<ZodString>>;purposes:ZodOptional<ZodArray<ZodString,"many">>>>; },"strict",ZodTypeAny, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>
Defined in: capability.ts:91
Authority issued to one subject and bounded by explicit constraints.
CapabilityRequestSchema
constCapabilityRequestSchema:ZodObject<{capabilities:ZodArray<ZodObject<{actions:ZodArray<ZodString,"many">>;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>;scope:ZodEnum<["exact","descendants"]>; },"strict",ZodTypeAny, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }>,"many">>;constraints:ZodOptional<ZodEffects<ZodObject<{delegationDepth:ZodOptional<ZodNumber>>;expiresAt:ZodOptional<ZodString>>;maxUses:ZodOptional<ZodNumber>>;notBefore:ZodOptional<ZodString>>;purposes:ZodOptional<ZodArray<ZodString,"many">>>>; },"strict",ZodTypeAny, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; }>>;id:ZodString;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;requestedAt:ZodString;requester:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints?: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;metadata?:JsonObject;namespaceId:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;requestedAt:string;requester: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints?: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;metadata?:JsonObject;namespaceId:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;requestedAt:string;requester: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>
Defined in: capability.ts:74
A request for authority. A request is not itself proof of authority.
CapabilityRequirementSchema
constCapabilityRequirementSchema:ZodObject<{action:ZodString;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>; },"strict",ZodTypeAny, {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }, {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }>
Defined in: capability.ts:108
The exact capability a tool invocation requires.
CapabilitySchema
constCapabilitySchema:ZodObject<{actions:ZodArray<ZodString,"many">>;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>;scope:ZodEnum<["exact","descendants"]>; },"strict",ZodTypeAny, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }, {actions:string[];resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; };scope:"exact"|"descendants"; }>
Defined in: capability.ts:38
A positive capability. SharedOS is deny-by-default when no grant matches.
EnabledToolNamespacesSchema
constEnabledToolNamespacesSchema:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>
Defined in: tool.ts:23
ExecutionEventSchema
constExecutionEventSchema:ZodObject<{data:ZodType<JsonValue,ZodTypeDef,JsonValue>>;eventId:ZodString;executionId:ZodString;occurredAt:ZodString;sequence:ZodNumber;traceId:ZodString;type:ZodString;version:ZodLiteral<"1">>; },"strict",ZodTypeAny, {data:JsonValue;eventId:string;executionId:string;occurredAt:string;sequence:number;traceId:string;type:string;version:"1"; }, {data:JsonValue;eventId:string;executionId:string;occurredAt:string;sequence:number;traceId:string;type:string;version:"1"; }>
Defined in: execution.ts:42
An append-only event emitted while executing a request.
ExecutionOptionsSchema
constExecutionOptionsSchema:ZodObject<{maxSteps:ZodOptional<ZodNumber>>;maxToolCalls:ZodOptional<ZodNumber>>;timeoutMs:ZodOptional<ZodNumber>>; },"strict",ZodTypeAny, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }>
Defined in: execution.ts:14
ExecutionRequestSchema
constExecutionRequestSchema:ZodObject<{agent:ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>;context:ZodObject<{actor:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;authority:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;enabledToolNamespaces:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>;grants:ZodArray<ZodObject<{capabilities:ZodArray<ZodObject<{actions:ZodArray<..., ...>;resource:ZodObject<..., ..., ..., ..., ...>;scope:ZodEnum<...>; },"strict",ZodTypeAny, {actions: ...[];resource: {namespace: ...;owner?: ...;path: ...; };scope: ... | ...; }, {actions: ...[];resource: {namespace: ...;owner?: ...;path: ...; };scope: ... | ...; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth:ZodOptional<...>;expiresAt:ZodOptional<...>;maxUses:ZodOptional<...>;notBefore:ZodOptional<...>;purposes:ZodOptional<...>; },"strict",ZodTypeAny, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<{kind: ...;userId: ...; },"strict",ZodTypeAny, {kind: ...;userId: ...; }, {kind: ...;userId: ...; }>,ZodObject<{agentId: ...;kind: ...; },"strict",ZodTypeAny, {agentId: ...;kind: ...; }, {agentId: ...;kind: ...; }>,ZodObject<{conversationId: ...;kind: ...; },"strict",ZodTypeAny, {conversationId: ...;kind: ...; }, {conversationId: ...;kind: ...; }>,ZodObject<{kind: ...;serviceId: ...; },"strict",ZodTypeAny, {kind: ...;serviceId: ...; }, {kind: ...;serviceId: ...; }>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<{kind: ...;userId: ...; },"strict",ZodTypeAny, {kind: ...;userId: ...; }, {kind: ...;userId: ...; }>,ZodObject<{agentId: ...;kind: ...; },"strict",ZodTypeAny, {agentId: ...;kind: ...; }, {agentId: ...;kind: ...; }>,ZodObject<{conversationId: ...;kind: ...; },"strict",ZodTypeAny, {conversationId: ...;kind: ...; }, {conversationId: ...;kind: ...; }>,ZodObject<{kind: ...;serviceId: ...; },"strict",ZodTypeAny, {kind: ...;serviceId: ...; }, {kind: ...;serviceId: ...; }>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>,"many">>;namespaceId:ZodString;now:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }>;executionId:ZodString;message:ZodObject<{createdAt:ZodString;id:ZodString;intent:ZodString;payload:ZodType<JsonValue,ZodTypeDef,JsonValue>>;provenance:ZodOptional<ZodObject<{metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;parentIds:ZodArray<ZodString,"many">>;source:ZodString; },"strict",ZodTypeAny, {metadata?:JsonObject;parentIds:string[];source:string; }, {metadata?:JsonObject;parentIds:string[];source:string; }>>;purpose:ZodString;receiver:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;replyTo:ZodOptional<ZodString>>;sender:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;traceId:ZodString;version:ZodLiteral<"1">>; },"strict",ZodTypeAny, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;options:ZodOptional<ZodObject<{maxSteps:ZodOptional<ZodNumber>>;maxToolCalls:ZodOptional<ZodNumber>>;timeoutMs:ZodOptional<ZodNumber>>; },"strict",ZodTypeAny, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }>>;state:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;tools:ZodArray<ZodEffects<ZodObject<{annotations:ZodOptional<ZodObject<{destructive:ZodOptional<ZodBoolean>>;idempotent:ZodOptional<ZodBoolean>>;readOnly:ZodOptional<ZodBoolean>>; },"strict",ZodTypeAny, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }>>;description:ZodString;inputSchema:ZodType<JsonObject,ZodTypeDef,JsonObject>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;name:ZodString;namespace:ZodString;outputSchema:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;readWrite:ZodEnum<["read","write"]>;requiredCapability:ZodObject<{action:ZodString;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<...>;path:ZodArray<..., ...>; },"strict",ZodTypeAny, {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }, {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }>; },"strict",ZodTypeAny, {action:string;resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; }; }, {action:string;resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; }; }>;source:ZodString; },"strict",ZodTypeAny, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }>, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }>,"many">>;version:ZodLiteral<"1">>; },"strict",ZodTypeAny, {agent: {agentId:string;kind:"agent"; };context: {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; };executionId:string;message: {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; };metadata?:JsonObject;options?: {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; };state?:JsonObject;tools:object[];version:"1"; }, {agent: {agentId:string;kind:"agent"; };context: {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; };executionId:string;message: {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; };metadata?:JsonObject;options?: {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; };state?:JsonObject;tools:object[];version:"1"; }>
Defined in: execution.ts:25
One permission-controlled agent turn. Tick scheduling stays with the host.
ExecutionResultSchema
constExecutionResultSchema:ZodDiscriminatedUnion<"status", [ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;events:object[];executionId:string;metadata?:JsonObject;output:JsonValue;startedAt:string;status:"succeeded";traceId:string;version:"1"; }, {completedAt:string;events:object[];executionId:string;metadata?:JsonObject;output:JsonValue;startedAt:string;status:"succeeded";traceId:string;version:"1"; }>,ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"denied";traceId:string;version:"1"; }, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"denied";traceId:string;version:"1"; }>,ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"failed";traceId:string;version:"1"; }, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"failed";traceId:string;version:"1"; }>,ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;error?: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"cancelled";traceId:string;version:"1"; }, {completedAt:string;error?: {code:string;details?:JsonObject;message:string;retryable?:boolean; };events:object[];executionId:string;metadata?:JsonObject;startedAt:string;status:"cancelled";traceId:string;version:"1"; }>]>
Defined in: execution.ts:67
GroupAddressSchema
constGroupAddressSchema:ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>
Defined in: address.ts:15
HumanAddressSchema
constHumanAddressSchema:ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>
Defined in: address.ts:5
IdentifierSchema
constIdentifierSchema:ZodString
Defined in: common.ts:8
An opaque identifier. Callers choose its format; SharedOS only requires stability.
JsonArraySchema
constJsonArraySchema:z.ZodType<JsonArray>>
Defined in: json.ts:28
JsonObjectSchema
constJsonObjectSchema:z.ZodType<JsonObject>>
Defined in: json.ts:27
JsonValueSchema
constJsonValueSchema:z.ZodType<JsonValue>>
Defined in: json.ts:16
Any value that can round-trip through JSON without custom serialization. In particular, this rejects undefined, bigint, Date, NaN, and Infinity.
MAX_EXECUTION_TIMEOUT_MS
constMAX_EXECUTION_TIMEOUT_MS:600000=600_000
Defined in: execution.ts:11
MAX_EXECUTION_TOOL_CALLS
constMAX_EXECUTION_TOOL_CALLS:10000=10_000
Defined in: execution.ts:12
MessageDeliveryResultSchema
constMessageDeliveryResultSchema:ZodDiscriminatedUnion<"status", [ZodObject<object&object,"strict",ZodTypeAny, {messageId:string;metadata?:JsonObject;status:"accepted";timestamp:string; }, {messageId:string;metadata?:JsonObject;status:"accepted";timestamp:string; }>,ZodObject<object&object,"strict",ZodTypeAny, {messageId:string;metadata?:JsonObject;status:"delivered";timestamp:string; }, {messageId:string;metadata?:JsonObject;status:"delivered";timestamp:string; }>,ZodObject<object&object,"strict",ZodTypeAny, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };messageId:string;metadata?:JsonObject;status:"denied";timestamp:string; }, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };messageId:string;metadata?:JsonObject;status:"denied";timestamp:string; }>,ZodObject<object&object,"strict",ZodTypeAny, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };messageId:string;metadata?:JsonObject;status:"failed";timestamp:string; }, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };messageId:string;metadata?:JsonObject;status:"failed";timestamp:string; }>]>
Defined in: message.ts:47
The transport-neutral outcome of submitting a message for delivery.
MessageEnvelopeSchema
constMessageEnvelopeSchema:ZodObject<{createdAt:ZodString;id:ZodString;intent:ZodString;payload:ZodType<JsonValue,ZodTypeDef,JsonValue>>;provenance:ZodOptional<ZodObject<{metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;parentIds:ZodArray<ZodString,"many">>;source:ZodString; },"strict",ZodTypeAny, {metadata?:JsonObject;parentIds:string[];source:string; }, {metadata?:JsonObject;parentIds:string[];source:string; }>>;purpose:ZodString;receiver:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;replyTo:ZodOptional<ZodString>>;sender:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;traceId:ZodString;version:ZodLiteral<"1">>; },"strict",ZodTypeAny, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }>
Defined in: message.ts:22
A message carries intent and context, never authority. Authority is supplied separately through AccessContext and evaluated at the point of use.
MessageProvenanceSchema
constMessageProvenanceSchema:ZodObject<{metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;parentIds:ZodArray<ZodString,"many">>;source:ZodString; },"strict",ZodTypeAny, {metadata?:JsonObject;parentIds:string[];source:string; }, {metadata?:JsonObject;parentIds:string[];source:string; }>
Defined in: message.ts:8
PathSegmentSchema
constPathSegmentSchema:ZodString
Defined in: capability.ts:15
One opaque resource-path segment.
Separators, traversal markers, and control characters are rejected here so every host receives the same canonical path vocabulary. Filesystem-backed providers must still resolve beneath their configured root and reject symlink escapes.
ProtocolErrorSchema
constProtocolErrorSchema:ZodObject<{code:ZodString;details:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;message:ZodString;retryable:ZodOptional<ZodBoolean>>; },"strict",ZodTypeAny, {code:string;details?:JsonObject;message:string;retryable?:boolean; }, {code:string;details?:JsonObject;message:string;retryable?:boolean; }>
Defined in: protocol-error.ts:7
A machine-readable error that is safe to return over npm and HTTP APIs.
ProtocolVersionSchema
constProtocolVersionSchema:ZodLiteral<"1">>
Defined in: common.ts:4
The wire protocol version implemented by this package.
RemoteExecutionRequestSchema
constRemoteExecutionRequestSchema:ZodObject<Omit<{agent:ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>;context:ZodObject<{actor:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;authority:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;enabledToolNamespaces:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>;grants:ZodArray<ZodObject<{capabilities:ZodArray<ZodObject<{actions: ...;resource: ...;scope: ...; },"strict",ZodTypeAny, {actions: ...;resource: ...;scope: ...; }, {actions: ...;resource: ...;scope: ...; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth: ...;expiresAt: ...;maxUses: ...;notBefore: ...;purposes: ...; },"strict",ZodTypeAny, {delegationDepth?: ...;expiresAt?: ...;maxUses?: ...;notBefore?: ...;purposes?: ...; }, {delegationDepth?: ...;expiresAt?: ...;maxUses?: ...;notBefore?: ...;purposes?: ...; }>, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>,"many">>;namespaceId:ZodString;now:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }>;executionId:ZodString;message:ZodObject<{createdAt:ZodString;id:ZodString;intent:ZodString;payload:ZodType<JsonValue,ZodTypeDef,JsonValue>>;provenance:ZodOptional<ZodObject<{metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;parentIds:ZodArray<ZodString,"many">>;source:ZodString; },"strict",ZodTypeAny, {metadata?:JsonObject;parentIds:string[];source:string; }, {metadata?:JsonObject;parentIds:string[];source:string; }>>;purpose:ZodString;receiver:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;replyTo:ZodOptional<ZodString>>;sender:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;traceId:ZodString;version:ZodLiteral<"1">>; },"strict",ZodTypeAny, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }, {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; }>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;options:ZodOptional<ZodObject<{maxSteps:ZodOptional<ZodNumber>>;maxToolCalls:ZodOptional<ZodNumber>>;timeoutMs:ZodOptional<ZodNumber>>; },"strict",ZodTypeAny, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }, {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; }>>;state:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;tools:ZodArray<ZodEffects<ZodObject<{annotations:ZodOptional<ZodObject<{destructive:ZodOptional<...>;idempotent:ZodOptional<...>;readOnly:ZodOptional<...>; },"strict",ZodTypeAny, {destructive?: ... | ... | ...;idempotent?: ... | ... | ...;readOnly?: ... | ... | ...; }, {destructive?: ... | ... | ...;idempotent?: ... | ... | ...;readOnly?: ... | ... | ...; }>>;description:ZodString;inputSchema:ZodType<JsonObject,ZodTypeDef,JsonObject>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;name:ZodString;namespace:ZodString;outputSchema:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;readWrite:ZodEnum<["read","write"]>;requiredCapability:ZodObject<{action:ZodString;resource:ZodObject<{namespace: ...;owner: ...;path: ...; },"strict",ZodTypeAny, {namespace: ...;owner?: ...;path: ...; }, {namespace: ...;owner?: ...;path: ...; }>; },"strict",ZodTypeAny, {action:string;resource: {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }; }, {action:string;resource: {namespace:string;owner?: ... | ... | ... | ... | ...;path: ...[]; }; }>;source:ZodString; },"strict",ZodTypeAny, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind: ...;userId: ...; } | {agentId: ...;kind: ...; } | {conversationId: ...;kind: ...; } | {kind: ...;serviceId: ...; };path:string[]; }; };source:string; }>, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }>,"many">>;version:ZodLiteral<"1">>; },"context"|"tools">>,"strict",ZodTypeAny, {agent: {agentId:string;kind:"agent"; };executionId:string;message: {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; };metadata?:JsonObject;options?: {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; };state?:JsonObject;version:"1"; }, {agent: {agentId:string;kind:"agent"; };executionId:string;message: {createdAt:string;id:string;intent:string;payload:JsonValue;provenance?: {metadata?:JsonObject;parentIds:string[];source:string; };purpose:string;receiver: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };replyTo?:string;sender: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };traceId:string;version:"1"; };metadata?:JsonObject;options?: {maxSteps?:number;maxToolCalls?:number;timeoutMs?:number; };state?:JsonObject;version:"1"; }>
Defined in: http.ts:14
Turn request accepted over HTTP; authority and visible tools are host-derived.
RemoteResourceOperationSchema
constRemoteResourceOperationSchema:ZodObject<Omit<{action:ZodString;context:ZodObject<{actor:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;authority:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;enabledToolNamespaces:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>;grants:ZodArray<ZodObject<{capabilities:ZodArray<ZodObject<{actions: ...;resource: ...;scope: ...; },"strict",ZodTypeAny, {actions: ...;resource: ...;scope: ...; }, {actions: ...;resource: ...;scope: ...; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth: ...;expiresAt: ...;maxUses: ...;notBefore: ...;purposes: ...; },"strict",ZodTypeAny, {delegationDepth?: ...;expiresAt?: ...;maxUses?: ...;notBefore?: ...;purposes?: ...; }, {delegationDepth?: ...;expiresAt?: ...;maxUses?: ...;notBefore?: ...;purposes?: ...; }>, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>,"many">>;namespaceId:ZodString;now:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }>;input:ZodOptional<ZodType<JsonValue,ZodTypeDef,JsonValue>>>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;operationId:ZodString;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<...>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<...>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<...>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<...>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>; },"context">>,"strict",ZodTypeAny, {action:string;input?:JsonValue;metadata?:JsonObject;operationId:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }, {action:string;input?:JsonValue;metadata?:JsonObject;operationId:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }>
Defined in: http.ts:8
Resource operation accepted over HTTP; authority is injected by the host.
ResourceOperationSchema
constResourceOperationSchema:ZodObject<{action:ZodString;context:ZodObject<{actor:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;authority:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;enabledToolNamespaces:ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>;grants:ZodArray<ZodObject<{capabilities:ZodArray<ZodObject<{actions:ZodArray<..., ...>;resource:ZodObject<..., ..., ..., ..., ...>;scope:ZodEnum<...>; },"strict",ZodTypeAny, {actions: ...[];resource: {namespace: ...;owner?: ...;path: ...; };scope: ... | ...; }, {actions: ...[];resource: {namespace: ...;owner?: ...;path: ...; };scope: ... | ...; }>,"many">>;constraints:ZodEffects<ZodObject<{delegationDepth:ZodOptional<...>;expiresAt:ZodOptional<...>;maxUses:ZodOptional<...>;notBefore:ZodOptional<...>;purposes:ZodOptional<...>; },"strict",ZodTypeAny, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }, {delegationDepth?: ... | ...;expiresAt?: ... | ...;maxUses?: ... | ...;notBefore?: ... | ...;purposes?: ... | ...; }>, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; }, {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?: ...[]; }>;id:ZodString;issuedAt:ZodString;issuer:ZodDiscriminatedUnion<"kind", [ZodObject<{kind: ...;userId: ...; },"strict",ZodTypeAny, {kind: ...;userId: ...; }, {kind: ...;userId: ...; }>,ZodObject<{agentId: ...;kind: ...; },"strict",ZodTypeAny, {agentId: ...;kind: ...; }, {agentId: ...;kind: ...; }>,ZodObject<{conversationId: ...;kind: ...; },"strict",ZodTypeAny, {conversationId: ...;kind: ...; }, {conversationId: ...;kind: ...; }>,ZodObject<{kind: ...;serviceId: ...; },"strict",ZodTypeAny, {kind: ...;serviceId: ...; }, {kind: ...;serviceId: ...; }>]>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;namespaceId:ZodString;revokedAt:ZodOptional<ZodString>>;subject:ZodDiscriminatedUnion<"kind", [ZodObject<{kind: ...;userId: ...; },"strict",ZodTypeAny, {kind: ...;userId: ...; }, {kind: ...;userId: ...; }>,ZodObject<{agentId: ...;kind: ...; },"strict",ZodTypeAny, {agentId: ...;kind: ...; }, {agentId: ...;kind: ...; }>,ZodObject<{conversationId: ...;kind: ...; },"strict",ZodTypeAny, {conversationId: ...;kind: ...; }, {conversationId: ...;kind: ...; }>,ZodObject<{kind: ...;serviceId: ...; },"strict",ZodTypeAny, {kind: ...;serviceId: ...; }, {kind: ...;serviceId: ...; }>]>; },"strict",ZodTypeAny, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }, {capabilities:object[];constraints: {delegationDepth?:number;expiresAt?:string;maxUses?:number;notBefore?:string;purposes?:string[]; };id:string;issuedAt:string;issuer: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };metadata?:JsonObject;namespaceId:string;revokedAt?:string;subject: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; }; }>,"many">>;namespaceId:ZodString;now:ZodString;owner:ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>;purpose:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }, {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; }>;input:ZodOptional<ZodType<JsonValue,ZodTypeDef,JsonValue>>>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;operationId:ZodString;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>; },"strict",ZodTypeAny, {action:string;context: {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; };input?:JsonValue;metadata?:JsonObject;operationId:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }, {action:string;context: {actor: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };authority: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };enabledToolNamespaces:string[];grants:object[];namespaceId:string;now:string;owner: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };purpose:string;traceId:string; };input?:JsonValue;metadata?:JsonObject;operationId:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }>
Defined in: resource.ts:10
A self-contained request to perform one permission-controlled operation.
ResourceRefSchema
constResourceRefSchema:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<{kind:ZodLiteral<"human">>;userId:ZodString; },"strict",ZodTypeAny, {kind:"human";userId:string; }, {kind:"human";userId:string; }>,ZodObject<{agentId:ZodString;kind:ZodLiteral<"agent">>; },"strict",ZodTypeAny, {agentId:string;kind:"agent"; }, {agentId:string;kind:"agent"; }>,ZodObject<{conversationId:ZodString;kind:ZodLiteral<"group">>; },"strict",ZodTypeAny, {conversationId:string;kind:"group"; }, {conversationId:string;kind:"group"; }>,ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>
Defined in: capability.ts:27
A host-independent reference to a resource exposed through SharedOS.
ResourceResultSchema
constResourceResultSchema:ZodDiscriminatedUnion<"status", [ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;metadata?:JsonObject;operationId:string;output:JsonValue;status:"succeeded"; }, {completedAt:string;metadata?:JsonObject;operationId:string;output:JsonValue;status:"succeeded"; }>,ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;operationId:string;status:"denied"; }, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;operationId:string;status:"denied"; }>,ZodObject<object&object,"strict",ZodTypeAny, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;operationId:string;status:"failed"; }, {completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;operationId:string;status:"failed"; }>]>
Defined in: resource.ts:29
RuntimeEventSchema
constRuntimeEventSchema:ZodObject<{data:ZodType<JsonValue,ZodTypeDef,JsonValue>>;type:ZodString; },"strict",ZodTypeAny, {data:JsonValue;type:string; }, {data:JsonValue;type:string; }>
Defined in: runtime.ts:20
A runtime-originated observation. The SharedOS envelope assigns its audit identity.
RuntimeManifestSchema
constRuntimeManifestSchema:ZodObject<{id:ZodString;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;protocolVersion:ZodLiteral<"1">>;version:ZodString; },"strict",ZodTypeAny, {id:string;metadata?:JsonObject;protocolVersion:"1";version:string; }, {id:string;metadata?:JsonObject;protocolVersion:"1";version:string; }>
Defined in: runtime.ts:8
Stable, JSON-safe provenance for one installed runtime implementation.
RuntimeTurnOutcomeSchema
constRuntimeTurnOutcomeSchema:ZodDiscriminatedUnion<"type", [ZodObject<object&object,"strict",ZodTypeAny, {metadata?:JsonObject;output:JsonValue;type:"complete"; }, {metadata?:JsonObject;output:JsonValue;type:"complete"; }>,ZodObject<object&object,"strict",ZodTypeAny, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;type:"fail"; }, {error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;type:"fail"; }>]>
Defined in: runtime.ts:34
The only terminal outcomes a runtime plugin may return for one bounded turn.
ServiceAddressSchema
constServiceAddressSchema:ZodObject<{kind:ZodLiteral<"service">>;serviceId:ZodString; },"strict",ZodTypeAny, {kind:"service";serviceId:string; }, {kind:"service";serviceId:string; }>
Defined in: address.ts:20
SharedOSApiErrorResponseSchema
constSharedOSApiErrorResponseSchema:ZodObject<{error:ZodObject<{code:ZodString;message:ZodString;requestId:ZodOptional<ZodString>>; },"strict",ZodTypeAny, {code:string;message:string;requestId?:string; }, {code:string;message:string;requestId?:string; }>; },"strict",ZodTypeAny, {error: {code:string;message:string;requestId?:string; }; }, {error: {code:string;message:string;requestId?:string; }; }>
Defined in: http.ts:28
SharedOSHealthSchema
constSharedOSHealthSchema:ZodObject<{protocolVersion:ZodLiteral<"1">>;status:ZodLiteral<"ok">>; },"strict",ZodTypeAny, {protocolVersion:"1";status:"ok"; }, {protocolVersion:"1";status:"ok"; }>
Defined in: http.ts:20
TimestampSchema
constTimestampSchema:ZodString
Defined in: common.ts:12
An RFC 3339 timestamp, represented as a string to remain JSON-safe.
ToolAnnotationsSchema
constToolAnnotationsSchema:ZodObject<{destructive:ZodOptional<ZodBoolean>>;idempotent:ZodOptional<ZodBoolean>>;readOnly:ZodOptional<ZodBoolean>>; },"strict",ZodTypeAny, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }>
Defined in: tool.ts:71
ToolCallSchema
constToolCallSchema:ZodObject<{arguments:ZodType<JsonObject,ZodTypeDef,JsonObject>>;id:ZodString;requestedAt:ZodString;tool:ZodString;traceId:ZodString; },"strict",ZodTypeAny, {arguments:JsonObject;id:string;requestedAt:string;tool:string;traceId:string; }, {arguments:JsonObject;id:string;requestedAt:string;tool:string;traceId:string; }>
Defined in: tool.ts:172
ToolDefinitionSchema
constToolDefinitionSchema:ZodEffects<ZodObject<{annotations:ZodOptional<ZodObject<{destructive:ZodOptional<ZodBoolean>>;idempotent:ZodOptional<ZodBoolean>>;readOnly:ZodOptional<ZodBoolean>>; },"strict",ZodTypeAny, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }, {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; }>>;description:ZodString;inputSchema:ZodType<JsonObject,ZodTypeDef,JsonObject>>;metadata:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;name:ZodString;namespace:ZodString;outputSchema:ZodOptional<ZodType<JsonObject,ZodTypeDef,JsonObject>>>>;readWrite:ZodEnum<["read","write"]>;requiredCapability:ZodObject<{action:ZodString;resource:ZodObject<{namespace:ZodString;owner:ZodOptional<ZodDiscriminatedUnion<"kind", [ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>,ZodObject<..., ..., ..., ..., ...>]>>;path:ZodArray<ZodString,"many">>; },"strict",ZodTypeAny, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }, {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }>; },"strict",ZodTypeAny, {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }, {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; }>;source:ZodString; },"strict",ZodTypeAny, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }>, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }, {annotations?: {destructive?:boolean;idempotent?:boolean;readOnly?:boolean; };description:string;inputSchema:JsonObject;metadata?:JsonObject;name:string;namespace:string;outputSchema?:JsonObject;readWrite:"read"|"write";requiredCapability: {action:string;resource: {namespace:string;owner?: {kind:"human";userId:string; } | {agentId:string;kind:"agent"; } | {conversationId:string;kind:"group"; } | {kind:"service";serviceId:string; };path:string[]; }; };source:string; }>
Defined in: tool.ts:82
A JSON-Schema-described tool bound to one permission requirement.
ToolNamespaceCatalogSchema
constToolNamespaceCatalogSchema:ZodEffects<ZodObject<{namespaces:ZodArray<ZodEffects<ZodObject<{enabled:ZodBoolean;namespace:ZodString;sources:ZodArray<ZodString,"many">>;toolCount:ZodNumber; },"strict",ZodTypeAny, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }>, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }>,"many">>;summary:ZodObject<{disabled:ZodNumber;enabled:ZodNumber;total:ZodNumber; },"strict",ZodTypeAny, {disabled:number;enabled:number;total:number; }, {disabled:number;enabled:number;total:number; }>; },"strict",ZodTypeAny, {namespaces:object[];summary: {disabled:number;enabled:number;total:number; }; }, {namespaces:object[];summary: {disabled:number;enabled:number;total:number; }; }>, {namespaces:object[];summary: {disabled:number;enabled:number;total:number; }; }, {namespaces:object[];summary: {disabled:number;enabled:number;total:number; }; }>
Defined in: tool.ts:134
ToolNamespaceDescriptorSchema
constToolNamespaceDescriptorSchema:ZodEffects<ZodObject<{enabled:ZodBoolean;namespace:ZodString;sources:ZodArray<ZodString,"many">>;toolCount:ZodNumber; },"strict",ZodTypeAny, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }>, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }, {enabled:boolean;namespace:string;sources:string[];toolCount:number; }>
Defined in: tool.ts:115
ToolNamespaceSchema
constToolNamespaceSchema:ZodString=IdentifierSchema
Defined in: tool.ts:9
A logical group of tools that a trusted host may enable for one access context.
ToolNamespaceUpdateSchema
constToolNamespaceUpdateSchema:ZodEffects<ZodObject<{disable:ZodOptional<ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>>;enable:ZodOptional<ZodEffects<ZodArray<ZodString,"many">>,string[],string[]>>; },"strict",ZodTypeAny, {disable?:string[];enable?:string[]; }, {disable?:string[];enable?:string[]; }>, {disable?:string[];enable?:string[]; }, {disable?:string[];enable?:string[]; }>
Defined in: tool.ts:42
An idempotent patch to a host-owned tool namespace selection.
The host applies this atomically and returns the authoritative effective selection after product policy ceilings have been enforced.
ToolReadWriteSchema
constToolReadWriteSchema:ZodEnum<["read","write"]>
Defined in: tool.ts:20
A conservative catalog classification. Capabilities remain the authorization source.
ToolResultSchema
constToolResultSchema:ZodDiscriminatedUnion<"status", [ZodObject<object&object,"strict",ZodTypeAny, {callId:string;completedAt:string;metadata?:JsonObject;output:JsonValue;status:"succeeded";tool:string; }, {callId:string;completedAt:string;metadata?:JsonObject;output:JsonValue;status:"succeeded";tool:string; }>,ZodObject<object&object,"strict",ZodTypeAny, {callId:string;completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;status:"denied";tool:string; }, {callId:string;completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;status:"denied";tool:string; }>,ZodObject<object&object,"strict",ZodTypeAny, {callId:string;completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;status:"failed";tool:string; }, {callId:string;completedAt:string;error: {code:string;details?:JsonObject;message:string;retryable?:boolean; };metadata?:JsonObject;status:"failed";tool:string; }>]>
Defined in: tool.ts:191
ToolSourceSchema
constToolSourceSchema:ZodString=IdentifierSchema
Defined in: tool.ts:16
The host-defined origin of a tool, for example sharedos, native, mcp,
or composio. This is catalog metadata, never proof of authority.