Class FindCandidateAgentsAction

Finds candidate AI agents for a given task using semantic search.

Backed by the unified Provider.SearchEntity pipeline (semantic mode over the daily-synced "AI Agents Search" EntityDocument). Extends the shared agent base (see BaseFindAgentsAction) to additionally surface each agent's sub-agents and default artifact type, and to optionally exclude Sub-Agents and child agents via the ExcludeSubAgents parameter.

Inputs: TaskDescription (required), MaxResults (default 5), MinimumSimilarityScore (cosine 0-1, default 0.5), IncludeInactive (default false), ExcludeSubAgents (default true).

Example

await runAction({
  ActionName: 'Find Candidate Agents',
  Params: [{ Name: 'TaskDescription', Value: 'Research market trends' }]
});

Hierarchy

BaseFindAgentsAction
- FindCandidateAgentsAction

Index

Constructors

constructor

new FindCandidateAgentsAction(): FindCandidateAgentsAction
Returns FindCandidateAgentsAction
Inherited from BaseFindAgentsAction.constructor

Accessors

`Protected`actionLabel

get actionLabel(): string
Verb used in error messages.

Returns string
Overrides BaseFindAgentsAction.actionLabel
- Defined in Actions/CoreActions/src/custom/ai/find-candidate-agents.action.ts:30

`Protected`entityName

get entityName(): string
Entity searched by this action.

Returns string
Inherited from BaseFindAgentsAction.entityName
- Defined in Actions/CoreActions/src/custom/ai/base-find-agents.action.ts:26

`Protected`includeSubAgentDetails

get includeSubAgentDetails(): boolean
Whether each result includes sub-agent details + default artifact type (candidate variant).

Returns boolean
Overrides BaseFindAgentsAction.includeSubAgentDetails
- Defined in Actions/CoreActions/src/custom/ai/find-candidate-agents.action.ts:31

Methods

`Protected`applyInvocationFilter

applyInvocationFilter(
agents: MJAIAgentEntityExtended[],
params: RunActionParams,
): MJAIAgentEntityExtended[]
Variant-specific invocation/parent filtering. Default excludes agents whose invocation mode is 'Sub-Agent' (they're meant to be called by other agents).
Parameters
- agents: MJAIAgentEntityExtended[]
- params: RunActionParams
Returns MJAIAgentEntityExtended[]
Overrides BaseFindAgentsAction.applyInvocationFilter
- Defined in Actions/CoreActions/src/custom/ai/find-candidate-agents.action.ts:33

`Protected`buildAgentResult

buildAgentResult(
agent: MJAIAgentEntityExtended,
score: number,
): Record<string, unknown>
Builds the per-agent result object, including sub-agent details for the candidate variant.
Parameters
- agent: MJAIAgentEntityExtended
- score: number
Returns Record<string, unknown>
Inherited from BaseFindAgentsAction.buildAgentResult
- Defined in Actions/CoreActions/src/custom/ai/base-find-agents.action.ts:173

`Protected`getAgentActionNames

getAgentActionNames(agentId: string): string[]
Action names available to the given agent.
Parameters
- agentId: string
Returns string[]
Inherited from BaseFindAgentsAction.getAgentActionNames
- Defined in Actions/CoreActions/src/custom/ai/base-find-agents.action.ts:145

`Protected`getSubAgents

getSubAgents(agentId: string): { description: string; name: string }[]
Sub-agents (direct children + relationship-linked) for the given agent.
Parameters
- agentId: string
Returns { description: string; name: string }[]
Inherited from BaseFindAgentsAction.getSubAgents
- Defined in Actions/CoreActions/src/custom/ai/base-find-agents.action.ts:152

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseFindAgentsAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/ai/base-find-agents.action.ts:40

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseFindAgentsAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37

Class FindCandidateAgentsAction

Example

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns FindCandidateAgentsAction

Accessors

`Protected`actionLabel

Returns string

`Protected`entityName

Returns string

`Protected`includeSubAgentDetails

Returns boolean

Methods

`Protected`applyInvocationFilter

Parameters

Returns MJAIAgentEntityExtended[]

`Protected`buildAgentResult

Parameters

Returns Record<string, unknown>

`Protected`getAgentActionNames

Parameters

Returns string[]

`Protected`getSubAgents

Parameters

Returns { description: string; name: string }[]

`Protected`InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Settings

On This Page

Class FindCandidateAgentsAction

Example

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns FindCandidateAgentsAction

Accessors

ProtectedactionLabel

Returns string

ProtectedentityName

Returns string

ProtectedincludeSubAgentDetails

Returns boolean

Methods

ProtectedapplyInvocationFilter

Parameters

Returns MJAIAgentEntityExtended[]

ProtectedbuildAgentResult

Parameters

Returns Record<string, unknown>

ProtectedgetAgentActionNames

Parameters

Returns string[]

ProtectedgetSubAgents

Parameters

Returns { description: string; name: string }[]

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Settings

On This Page

`Protected`actionLabel

`Protected`entityName

`Protected`includeSubAgentDetails

`Protected`applyInvocationFilter

`Protected`buildAgentResult

`Protected`getAgentActionNames

`Protected`getSubAgents

`Protected`InternalRunAction