Documentation Index
Fetch the complete documentation index at: https://docs.agentfront.dev/llms.txt
Use this file to discover all available pages before exploring further.
Overview
import { AgentRegistry } from '@frontmcp/sdk';
// Access via scope
const agents = scope.agents;
// List all agents
const allAgents = agents.getAgents();
// Find by ID
const agent = agents.findById('research-agent');
// Get agents as callable tools
const agentTools = agents.getAgentsAsTools();
Methods
getAgents()
Get all agents (local + adopted).
getAgents(includeHidden?: boolean): ReadonlyArray<AgentEntry>
| Parameter | Type | Default | Description |
|---|
includeHidden | boolean | false | Include hidden agents |
const agents = registry.getAgents();
for (const agent of agents) {
console.log(`Agent: ${agent.id} - ${agent.description}`);
}
findById()
Find an agent by its ID.
findById(id: string): AgentEntry | undefined
const agent = registry.findById('research-agent');
if (agent) {
console.log(`Found: ${agent.name}`);
}
findByName()
Find an agent by its name.
findByName(name: string): AgentEntry | undefined
const agent = registry.findByName('research');
getVisibleAgentsFor()
Get agents visible to a specific agent.
getVisibleAgentsFor(agentId: string): ReadonlyArray<AgentEntry>
// Get agents that 'orchestrator' can call
const visibleAgents = registry.getVisibleAgentsFor('orchestrator');
getAgentsAsTools(): ReadonlyArray<ToolDefinition>
const agentTools = registry.getAgentsAsTools();
// Each agent becomes a callable tool with its input schema
getAgentToolsFor(agentId: string): ReadonlyArray<ToolDefinition>
// Get tools available to 'coordinator' agent
const tools = registry.getAgentToolsFor('coordinator');
getInlineAgents()
Get only agents defined inline in this registry.
getInlineAgents(): ReadonlyArray<AgentEntry>
listAllInstances()
List all agent instances (locals + adopted).
listAllInstances(): ReadonlyArray<AgentEntry>
subscribe()
Subscribe to agent change events.
subscribe(
opts: SubscribeOptions,
cb: (event: AgentChangeEvent) => void
): () => void
const unsubscribe = registry.subscribe({}, (event) => {
console.log(`Agent ${event.kind}:`, event.entry?.id);
});
// Later
unsubscribe();
getCapabilities()
Get MCP capabilities for agents.
getCapabilities(): { listChanged: boolean }
hasAny()
Check if any agents exist.
adoptFromChild()
Adopt agents from a child registry.
adoptFromChild(child: AgentRegistry, childOwner: Owner): void
removeChild()
Remove a child registry and clean up subscriptions.
removeChild(child: AgentRegistry): void
dispose()
Dispose registry and clean up all child subscriptions.
Change Events
interface AgentChangeEvent {
kind: 'added' | 'updated' | 'removed' | 'reset';
changeScope: 'global' | 'session';
version: number;
snapshot: ReadonlyArray<AgentEntry>;
entry?: AgentEntry;
sessionId?: string;
relatedRequestId?: string;
}
Indexes
| Index | Key | Description |
|---|
byQualifiedId | qualifiedId | Unique identifier lookup |
byId | id | Agent ID lookup (unique to AgentRegistry) |
byName | name | Base name lookup |
byOwner | ownerPath | All agents by owner |
Agent Visibility
Agents can control which other agents they can see and call:
@Agent({
id: 'coordinator',
name: 'Coordinator',
description: 'Coordinates research tasks',
visibleAgents: ['researcher', 'writer'], // Can only call these agents
})
class CoordinatorAgent extends AgentContext { }
getVisibleAgentsFor() to query visibility:
const visible = registry.getVisibleAgentsFor('coordinator');
// Returns only 'researcher' and 'writer' agents
@Agent({
id: 'research',
name: 'Research Agent',
inputSchema: {
topic: z.string(),
depth: z.enum(['shallow', 'deep']),
},
})
class ResearchAgent extends AgentContext { }
// The agent becomes callable as a tool
await client.callTool('research', {
topic: 'AI advancements',
depth: 'deep',
});
