> ## 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. # Scope > Scope provides access to all registries and services within a FrontMCP server. It's the central point for accessing tools, resources, prompts, agents, skills, and other registered components. ## Class Definition ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} export class Scope extends ScopeEntry { readonly id: string; readonly logger: FrontMcpLogger; readonly entryPath: string; readonly routeBase: string; readonly ready: Promise; readonly metadata: ScopeMetadata; } ``` ## Properties | Property | Type | Description | | ----------- | ---------------- | ----------------------- | | `id` | `string` | Unique scope identifier | | `logger` | `FrontMcpLogger` | Scope-specific logger | | `entryPath` | `string` | HTTP entry path | | `routeBase` | `string` | Route prefix | | `ready` | `Promise` | Initialization promise | | `metadata` | `ScopeMetadata` | Configuration metadata | ### ScopeMetadata `ScopeMetadata` is a union type: ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} type ScopeMetadata = AppScopeMetadata | MultiAppScopeMetadata; ``` * **`AppScopeMetadata`** — Used for single-app scopes (created when `splitByApp` splits each app into its own scope). Contains a single `apps: [AppType]` entry plus the parent server config (info, auth, etc.). * **`MultiAppScopeMetadata`** — Used for multi-app scopes (the default). Contains `apps: AppType[]` with all registered apps. Both include an `id` field (unique scope identifier) and the full server configuration from `@FrontMcp()`. Defined in `libs/sdk/src/common/metadata/front-mcp.metadata.ts`. ## Registry Accessors ### tools Get the tool registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get tools(): ToolRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const tools = scope.tools.getTools(); const tool = scope.tools.getExported('my_tool'); ``` ### resources Get the resource registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get resources(): ResourceRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const resources = scope.resources.getResources(); const templates = scope.resources.getResourceTemplates(); const resource = scope.resources.findResourceForUri('config://app'); ``` ### prompts Get the prompt registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get prompts(): PromptRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const prompts = scope.prompts.getPrompts(); const prompt = scope.prompts.findByName('research'); ``` ### agents Get the agent registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get agents(): AgentRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const agents = scope.agents.getAgents(); const agent = scope.agents.findByName('research-agent'); ``` ### skills Get the skill registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get skills(): SkillRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const skills = scope.skills.getSkills(); const searchResults = await scope.skills.search('code review', { topK: 5 }); ``` ### providers Get the provider registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get providers(): ProviderRegistry ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const service = scope.providers.get(ServiceToken); ``` ### auth Get the primary auth provider. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get auth(): FrontMcpAuth ``` ### authProviders Get the auth registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get authProviders(): AuthRegistry ``` ### apps Get the app registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get apps(): AppRegistry ``` ### hooks Get the hook registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get hooks(): HookRegistryInterface ``` ### plugins Get the plugin registry (if configured). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get plugins(): PluginRegistry | undefined ``` ### jobs Get the job registry (when `jobs.enabled` is set on the server). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get jobs(): JobRegistry | undefined ``` ### workflows Get the workflow registry (when `jobs.enabled` is set on the server). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get workflows(): WorkflowRegistry | undefined ``` ### channels Get the channel registry (when `channels.enabled` is set on the server). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get channels(): ChannelRegistry | undefined ``` ## Service Accessors ### notifications Get the notification service. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get notifications(): NotificationService ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} scope.notifications.on('tool-called', (event) => { console.log('Tool called:', event.toolName); }); ``` ### elicitationStore Get the elicitation store (if configured). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get elicitationStore(): ElicitationStore | undefined ``` ### eventStore Get the event store (if configured). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get eventStore(): EventStore | undefined ``` ### tasks Get the task registry for MCP 2025-11-25 background tasks (if enabled). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get tasks(): TaskRegistry | undefined ``` ### taskStore Get the persistent task record store (if tasks are enabled). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get taskStore(): TaskStore | undefined ``` ### channelNotifications Get the channel notification service (if channels are enabled). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get channelNotifications(): ChannelNotificationService | undefined ``` ### channelEventBus Get the in-process channel event bus (if channels are enabled). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get channelEventBus(): ChannelEventBus | undefined ``` ### skillSession Get the skill session manager (if skills exist). ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get skillSession(): SkillSessionManager | undefined ``` ### toolUI Get the tool UI registry. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} get toolUI(): ToolUIRegistry ``` ## Flow Execution ### runFlow(name, input, deps?) Execute a named flow. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} runFlow( name: Name, input: FlowInputOf, deps?: Map ): Promise | undefined> ``` ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const result = await scope.runFlow('tools:call-tool', { request: { method: 'tools/call', params: { name: 'my_tool', arguments: { input: 'test' } }, }, ctx: { authInfo }, }); ``` ### runFlowForOutput(name, input, deps?) Execute a flow and assert output exists. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} runFlowForOutput( name: Name, input: FlowInputOf, deps?: Map ): Promise> ``` ### registryFlows(...flows) Register additional flows. ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} registryFlows(...flows: FlowType[]): Promise ``` ## Accessing Scope ### In Tools/Resources/Agents ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} @Tool({ name: 'my_tool', inputSchema: {} }) class MyTool extends ToolContext { async execute() { // Access scope const tools = this.scope.tools; const resources = this.scope.resources; // List other tools const allTools = tools.getTools(); return { toolCount: allTools.length }; } } ``` ### From FrontMcpInstance ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const instance = await FrontMcpInstance.createForGraph(config); const scopes = instance.getScopes(); const scope = scopes[0]; console.log('Tools:', scope.tools.getTools().length); ``` ### From DirectClient The scope is internal to DirectClient, accessed through its methods: ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const client = await connect(config); const tools = await client.listTools(); // Uses scope.tools internally ``` ## Usage Examples ### Introspection ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const instance = await FrontMcpInstance.createForGraph(config); const [scope] = instance.getScopes(); // List all tools scope.tools.getTools().forEach(tool => { console.log(`Tool: ${tool.name}`); console.log(` Description: ${tool.description}`); console.log(` Input: ${JSON.stringify(tool.inputSchema)}`); }); // List all resources scope.resources.getResources().forEach(resource => { console.log(`Resource: ${resource.name} - ${resource.uri}`); }); // List all skills scope.skills.getSkills().forEach(skill => { console.log(`Skill: ${skill.name}`); console.log(` Tools: ${skill.tools.map(t => t.name).join(', ')}`); }); ``` ### Event Handling ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const scope = instance.getScopes()[0]; // Subscribe to tool changes scope.tools.subscribe({}, (event) => { console.log(`Tool ${event.kind}:`, event); }); // Subscribe to notifications scope.notifications.on('progress', (event) => { console.log(`Progress: ${event.progress}/${event.total}`); }); ``` ### Skill Sessions `SkillSessionManager` runs inside an `AsyncLocalStorage` context — call `runWithSession(sessionId, fn)` first, then query session state from inside `fn`: ```typescript theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} const scope = instance.getScopes()[0]; if (scope.skillSession) { await scope.skillSession.runWithSession(sessionId, async () => { const allowlist = scope.skillSession!.getToolAllowlist(); const canUse = scope.skillSession!.isToolAllowed('my_tool'); const activeIds = scope.skillSession!.getActiveSkillIds(); }); } ``` ## Initialization Sequence The Scope initializes in this order: 1. Providers 2. Hooks 3. Flows 4. Transport Service 5. Elicitation Store 6. Auth Registry 7. Apps Registry 8. Plugins 9. Tools Registry 10. Tool UI Registry 11. Resources Registry 12. Prompts Registry 13. Agents Registry 14. Skills Registry + Session Manager 15. Notification Service 16. Additional Flows ## Related Server bootstrap Tool registry Resource registry Skill registry