rea-agents
Preparing search index...
server/observationToolRegistration
ObservationToolSpec
Interface ObservationToolSpec<Schema>
Spec for a single observation tool with optional evidence projection.
interface
ObservationToolSpec
<
Schema
extends
z.ZodType
>
{
contract
:
ToolContract
;
execute
:
(
parsed
:
output
<
Schema
>
,
context
:
ObservationToolContext
,
)
=>
Promise
<
Result
<
|
{
analysis_profile
:
{
digest
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
}
;
provider_profile_schema_version
:
number
;
schema_version
:
1
;
}
;
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
|
{
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
,
AnalysisError
,
>
,
>
;
projectEvidence
?:
(
evidence
:
|
{
analysis_profile
:
{
digest
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
}
;
provider_profile_schema_version
:
number
;
schema_version
:
1
;
}
;
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
|
{
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
,
parsed
:
output
<
Schema
>
,
)
=>
{
structured
:
JSONType
;
text
?:
JSONType
}
|
undefined
;
schema
:
Schema
;
}
Type Parameters
Schema
extends
z.ZodType
Index
Properties
contract
execute
project
Evidence?
schema
Properties
Readonly
contract
contract
:
ToolContract
Readonly
execute
execute
:
(
parsed
:
output
<
Schema
>
,
context
:
ObservationToolContext
,
)
=>
Promise
<
Result
<
|
{
analysis_profile
:
{
digest
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
}
;
provider_profile_schema_version
:
number
;
schema_version
:
1
;
}
;
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
|
{
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
,
AnalysisError
,
>
,
>
Optional
Readonly
project
Evidence
projectEvidence
?:
(
evidence
:
|
{
analysis_profile
:
{
digest
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
}
;
provider_profile_schema_version
:
number
;
schema_version
:
1
;
}
;
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
|
{
authority
:
|
"shipped-artifact"
|
"controlled-replay"
|
"historical-reference"
|
"external-service"
|
"analyst-inference"
;
confidence
:
"observed"
|
"derived"
|
"inferred"
;
environment
:
|
{
architecture
:
string
;
id
:
string
;
isolation
:
"process"
|
"none"
|
"container"
|
"virtual-machine"
;
platform
:
string
;
}
|
null
;
evidence_id
:
string
;
evidence_links
:
string
[]
;
limitations
:
string
[]
;
locations
:
(
|
{
address
:
string
;
kind
:
"address"
}
|
{
end
:
string
;
kind
:
"address-range"
;
start
:
string
}
|
{
kind
:
"artifact-path"
;
path
:
string
}
|
{
kind
:
"file-offset"
;
offset
:
number
}
|
{
end
:
number
;
kind
:
"file-offset-range"
;
start
:
number
}
)
[]
;
normalized_result
:
JSONType
;
operation
:
string
;
parameters
:
Record
<
string
,
JSONType
>
;
predicate_type
:
string
;
provider
:
{
id
:
string
;
name
:
string
;
version
:
string
|
null
}
;
raw_result
:
JSONType
;
schema_version
:
2
;
subject
:
|
{
architecture
:
"x86"
|
"x86_64"
|
"arm"
|
"arm64"
|
null
;
digest
:
{
sha256
:
string
}
;
format
:
|
"unknown"
|
"file"
|
"directory"
|
"javascript"
|
"source-map"
|
"plist"
|
"entitlements"
|
"dmg"
|
"zip"
|
"pkg"
|
"asar"
|
"javascript-bundle"
|
"mach-o-universal"
|
"mach-o"
|
"elf"
|
"pe"
|
"hopper"
|
"analysis-database"
|
"ipa"
|
"apk"
;
local_path
:
string
;
name
:
string
;
}
|
null
;
}
,
parsed
:
output
<
Schema
>
,
)
=>
{
structured
:
JSONType
;
text
?:
JSONType
}
|
undefined
Readonly
schema
schema
:
Schema
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
contract
execute
project
Evidence
schema
rea-agents
Loading...
Spec for a single observation tool with optional evidence projection.