Skip to content

harness

FieldValue
Prefixharness
Namespace constantHarnessNamespace
Subjects constantHarnessSubjects
Kindbus
Schema recordHarnessSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/harness/namespace.ts
KeyWireTypeSchema
createdharness.createdeventschemas.ts
deleteharness.deleterpc
deletedharness.deletedevent
getharness.getrpc
getDefaultharness.getDefaultrpc
getSchemaharness.getSchemarpc
listharness.listrpc
resolveharness.resolverpc
setharness.setrpc
updatedharness.updatedeventschemas.ts

Emitted after a new harness definition is inserted.

Subject: harness.created Type: Event

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access"yes
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
createdAtnumberyes
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledbooleanyes
envRecord<string, string> | undefinedno
idstringyes
isDefaultbooleanyes
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno
updatedAtnumberyes

Subject: harness.delete Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes

Response:

FieldTypeRequired
successbooleanyes

Emitted after a harness definition is deleted.

Subject: harness.deleted Type: Event

FieldTypeRequired
idstringyes

Subject: harness.get Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestring | undefinedno
idstring | undefinedno
namestring | undefinedno

Response:

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access"yes
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
createdAtnumberyes
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledbooleanyes
envRecord<string, string> | undefinedno
idstringyes
isDefaultbooleanyes
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno
updatedAtnumberyes

Subject: harness.getDefault Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestring | undefinedno
clientIdstring | undefinedno

Response:

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access"yes
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
createdAtnumberyes
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledbooleanyes
envRecord<string, string> | undefinedno
idstringyes
isDefaultbooleanyes
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno
updatedAtnumberyes

Subject: harness.getSchema Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
schemaRecord<string, unknown>yes
uiConfig{ editMode: "inline" | "slidePanel" | "fullPage"; hiddenFields?: string[] | undefined; readOnlyInEditMode?: string[] | undefined; fieldOverrides?: Record<string, { widget?: string | undefined; delimiter?: string | undefined; placeholder?: string | undefined; helpText?: string | undefined; min?: number | undefined; max?: number | undefined; step?: number | undefined; options?: { value: string; label: string; }[] | undefined; }> | undefined; sections?: { id: string; title: string; fields: string[]; description?: string | undefined; }[] | undefined; }yes

Subject: harness.list Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestring | undefinedno
clientIdstring | undefinedno
namestring | undefinedno

Response:

FieldTypeRequired
harnesses{ id: string; name: string; approvalPolicy: "reject" | "always-ask" | "full-access"; nativeTools: { enabled: string[]; disabled: string[]; }; registryTools: { enabled: string[]; disabled: string[]; }; isDefault: boolean; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; adapterName?: string | undefined; clientId?: string | undefined; skills?: { enabled: string[]; disabled: string[]; } | undefined; toolCapabilityMap?: Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined; capabilityOverrides?: Record<string, "reject" | "always-ask" | "full-access"> | undefined; toolApprovalOverrides?: Record<string, "reject" | "always-ask" | "full-access"> | undefined; env?: Record<string, string> | undefined; credentials?: Record<string, string> | undefined; cwd?: string | undefined; }[]yes

Subject: harness.resolve Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestring | undefinedno
clientIdstring | undefinedno
personaHarnessIdstring | undefinedno
profileHarnessIdstring | undefinedno

Response:

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access"yes
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
createdAtnumberyes
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledbooleanyes
envRecord<string, string> | undefinedno
idstringyes
isDefaultbooleanyes
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno
updatedAtnumberyes

Subject: harness.set Type: Request (RPC)

Request:

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access" | undefinedno
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledboolean | undefinedno
envRecord<string, string> | undefinedno
isDefaultboolean | undefinedno
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno

Response:

FieldTypeRequired
idstringyes

Emitted after an existing harness definition is updated.

Subject: harness.updated Type: Event

FieldTypeRequired
adapterNamestring | undefinedno
approvalPolicy"reject" | "always-ask" | "full-access"yes
capabilityOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
clientIdstring | undefinedno
createdAtnumberyes
credentialsRecord<string, string> | undefinedno
cwdstring | undefinedno
descriptionstring | undefinedno
enabledbooleanyes
envRecord<string, string> | undefinedno
idstringyes
isDefaultbooleanyes
namestringyes
nativeTools{ enabled: string[]; disabled: string[]; }yes
registryTools{ enabled: string[]; disabled: string[]; }yes
skills{ enabled: string[]; disabled: string[]; } | undefinedno
toolApprovalOverridesRecord<string, "reject" | "always-ask" | "full-access"> | undefinedno
toolCapabilityMapRecord<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefinedno
updatedAtnumberyes

Auto-generated by yarn docs:bus. Do not edit manually.