harness
harness
Section titled “harness”| Field | Value |
|---|---|
| Prefix | harness |
| Namespace constant | HarnessNamespace |
| Subjects constant | HarnessSubjects |
| Kind | bus |
| Schema record | HarnessSchemas |
| Tier | framework |
| Package | @makaio/contracts |
| Defined in | packages/contracts/src/harness/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
created | harness.created | event | schemas.ts |
delete | harness.delete | rpc | — |
deleted | harness.deleted | event | — |
get | harness.get | rpc | — |
getDefault | harness.getDefault | rpc | — |
getSchema | harness.getSchema | rpc | — |
list | harness.list | rpc | — |
resolve | harness.resolve | rpc | — |
set | harness.set | rpc | — |
updated | harness.updated | event | schemas.ts |
Subject Details
Section titled “Subject Details”harness.created (event)
Section titled “harness.created (event)”Emitted after a new harness definition is inserted.
Subject: harness.created
Type: Event
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | yes |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
createdAt | number | yes |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | yes |
env | Record<string, string> | undefined | no |
id | string | yes |
isDefault | boolean | yes |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
updatedAt | number | yes |
harness.delete (rpc)
Section titled “harness.delete (rpc)”Subject: harness.delete
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
id | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
success | boolean | yes |
harness.deleted (event)
Section titled “harness.deleted (event)”Emitted after a harness definition is deleted.
Subject: harness.deleted
Type: Event
| Field | Type | Required |
|---|---|---|
id | string | yes |
harness.get (rpc)
Section titled “harness.get (rpc)”Subject: harness.get
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
id | string | undefined | no |
name | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | yes |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
createdAt | number | yes |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | yes |
env | Record<string, string> | undefined | no |
id | string | yes |
isDefault | boolean | yes |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
updatedAt | number | yes |
harness.getDefault (rpc)
Section titled “harness.getDefault (rpc)”Subject: harness.getDefault
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
clientId | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | yes |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
createdAt | number | yes |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | yes |
env | Record<string, string> | undefined | no |
id | string | yes |
isDefault | boolean | yes |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
updatedAt | number | yes |
harness.getSchema (rpc)
Section titled “harness.getSchema (rpc)”Subject: harness.getSchema
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
schema | Record<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 |
harness.list (rpc)
Section titled “harness.list (rpc)”Subject: harness.list
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
clientId | string | undefined | no |
name | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
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 |
harness.resolve (rpc)
Section titled “harness.resolve (rpc)”Subject: harness.resolve
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
clientId | string | undefined | no |
personaHarnessId | string | undefined | no |
profileHarnessId | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | yes |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
createdAt | number | yes |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | yes |
env | Record<string, string> | undefined | no |
id | string | yes |
isDefault | boolean | yes |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
updatedAt | number | yes |
harness.set (rpc)
Section titled “harness.set (rpc)”Subject: harness.set
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | undefined | no |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | undefined | no |
env | Record<string, string> | undefined | no |
isDefault | boolean | undefined | no |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
id | string | yes |
harness.updated (event)
Section titled “harness.updated (event)”Emitted after an existing harness definition is updated.
Subject: harness.updated
Type: Event
| Field | Type | Required |
|---|---|---|
adapterName | string | undefined | no |
approvalPolicy | "reject" | "always-ask" | "full-access" | yes |
capabilityOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
clientId | string | undefined | no |
createdAt | number | yes |
credentials | Record<string, string> | undefined | no |
cwd | string | undefined | no |
description | string | undefined | no |
enabled | boolean | yes |
env | Record<string, string> | undefined | no |
id | string | yes |
isDefault | boolean | yes |
name | string | yes |
nativeTools | { enabled: string[]; disabled: string[]; } | yes |
registryTools | { enabled: string[]; disabled: string[]; } | yes |
skills | { enabled: string[]; disabled: string[]; } | undefined | no |
toolApprovalOverrides | Record<string, "reject" | "always-ask" | "full-access"> | undefined | no |
toolCapabilityMap | Record<string, readonly ("file.read" | "file.write" | "file.delete" | "search.content" | "search.files" | "search.web" | "shell.execute" | "network.request" | "process.manage")[]> | undefined | no |
updatedAt | number | yes |
Auto-generated by yarn docs:bus. Do not edit manually.