findAgent

codebolt.agent.findAgent(task: string, maxResult: number, agents: array, agentLocation: string, getFrom: string): Promise<FindAgentByTaskResponse>

Finds an agent suitable for the specified task using AI and/or vector database filtering.

Parameters

Name	Type	Description
task	string	The task description for which an agent is needed (e.g., "Write a function to sum of Two number", "create node js app").
maxResult	number	Maximum number of agents to return (default 1, commonly used values are 3-10).
agents	array	List of specific agent names/IDs to filter in vector database (empty array for no filtering).
agentLocation	string	Location preference for agents. Valid values are 'remote_only', 'local_only', 'all'. Default is 'all'.
getFrom	string	Filtering method. Valid values are 'use_ai', 'use_vector_db', 'use_both'. Default is 'use_vector_db'.

Returns:

 Promise<FindAgentByTaskResponse>

A promise that resolves with a findAgentByTaskResponse object containing an array of found agents.

Response Structure

The method returns a Promise that resolves to a FindAgentByTaskResponse object with:

• type: The response type, always "findAgentByTaskResponse"
• agents: Array of found agents, each containing:
  • type: The agent type, typically "function"
  • function: Agent function details including:
    • name: The name/identifier of the agent
    • description: Detailed description of the agent's capabilities
    • parameters: Parameter specification object with type, properties, required fields, and additionalProperties flag
    • strict: Boolean indicating whether the agent enforces strict parameter validation

Examples

// Example 1: Find agents for a specific task with default parameters
const agent = await codebolt.agent.findAgent("Write a function to sum of Two number");
console.log("Found Agent:", agent);

// Example 2: Find multiple agents with remote-only preference
const agents = await codebolt.agent.findAgent(
  "create node js app",
  10, // maxResult
  [], // agents filter
  'remote_only', // agentLocation
  'use_both' // getFrom
);
console.log("Found Agents:", agents);

// Example 3: Find agents using AI filtering with local-only preference
const aiFilteredAgents = await codebolt.agent.findAgent(
  "Analyze data and provide insights",
  1,
  [],
  'local_only',
  'use_ai'
);
console.log("AI Filtered Agents:", aiFilteredAgents);

// Example 4: Find agents with specific agent filtering
const filteredAgents = await codebolt.agent.findAgent(
  "Code generation task",
  2,
  ['agent1', 'agent2'], // specific agents to filter
  'all',
  'use_both'
);
console.log("Filtered Agents:", filteredAgents);

Notes

• The task parameter should be a clear description of what you want the agent to do
• When using remote_only or local_only, make sure you have agents available in those locations
• Using use_both for filtering provides the most comprehensive results but may be slower
• The returned agents array contains detailed information about each agent including their capabilities and metadata
• Each agent in the response includes its function signature and parameter requirements