ResourceRegistry

import { ResourceRegistry } from '@frontmcp/sdk';

// Access via scope
const resources = scope.resources;

// List all static resources
const allResources = resources.getResources();

// List all resource templates
const templates = resources.getResourceTemplates();

// Find by URI
const resource = resources.findByUri('file:///config.json');

getResources(includeHidden?: boolean): ReadonlyArray<ResourceEntry>

// Get all visible resources
const resources = registry.getResources();

// Include hidden resources
const allResources = registry.getResources(true);

getResourceTemplates(): ReadonlyArray<ResourceEntry>

const templates = registry.getResourceTemplates();
for (const template of templates) {
  console.log(`Template: ${template.uriTemplate}`);
}

findByUri(uri: string): ResourceEntry | undefined

const resource = registry.findByUri('file:///config.json');
if (resource) {
  console.log(`Found: ${resource.name}`);
}

matchTemplateByUri(uri: string): {
  template: ResourceEntry;
  params: Record<string, string>;
} | undefined

// Given template: 'file:///users/{userId}/profile'
const match = registry.matchTemplateByUri('file:///users/123/profile');
if (match) {
  console.log(match.template.name); // user-profile
  console.log(match.params); // { userId: '123' }
}

findResourceForUri(uri: string): ResourceEntry | undefined

// Will try exact match first, then template matching
const resource = registry.findResourceForUri('file:///users/123/profile');

getExported(name: string, opts?: { ignoreCase?: boolean }): ResourceEntry | undefined

exportResolvedNames(opts?: ExportResolvedNamesOptions): Map<string, ResourceEntry>

getInlineResources(): ReadonlyArray<ResourceEntry>

listAllInstances(): ReadonlyArray<ResourceEntry>

listByOwner(ownerPath: string): ReadonlyArray<ResourceEntry>

registerResourceInstance(resource: ResourceEntry): void

registerDynamicResource(resourceDef: DynamicResourceDef): ResourceEntry

// Register a dynamic resource
const entry = registry.registerDynamicResource({
  name: 'dynamic-config',
  uri: 'config://runtime',
  description: 'Runtime configuration',
  mimeType: 'application/json',
  read: async () => ({ text: JSON.stringify(config) }),
});

subscribe(
  opts: SubscribeOptions,
  cb: (event: ResourceChangeEvent) => void
): () => void

const unsubscribe = registry.subscribe({}, (event) => {
  console.log(`Resource change: ${event.kind} (v${event.version})`);
  if (event.updatedUri) {
    console.log(`Updated URI: ${event.updatedUri}`);
  }
});

// Later
unsubscribe();

getCapabilities(): { subscribe: boolean; listChanged: boolean }

const caps = registry.getCapabilities();
// { subscribe: false, listChanged: true }

hasAny(): boolean

adoptFromChild(child: ResourceRegistry, childOwner: Owner): void

interface ResourceChangeEvent {
  kind: 'added' | 'updated' | 'removed' | 'reset';
  changeScope: 'global' | 'session';
  version: number;
  snapshot: ReadonlyArray<ResourceEntry>;
  sessionId?: string;
  relatedRequestId?: string;
  /** URI of the specific resource whose content changed (for kind: 'updated') */
  updatedUri?: string;
}

// Static resource
@Resource({
  name: 'config',
  uri: 'file:///config.json',
})
class ConfigResource extends ResourceContext { }

// Template resource
@ResourceTemplate({
  name: 'user-profile',
  uriTemplate: 'file:///users/{userId}/profile',
})
class UserProfileResource extends ResourceContext<{ userId: string }> { }