Skip to main content
Generates a @Resource (static URI) or @ResourceTemplate (dynamic URI with parameters) class.

Usage

nx g @frontmcp/nx:resource user-profile --project crm
nx g @frontmcp/nx:resource user-profile --project crm --template

Options

OptionTypeDefaultDescription
namestringRequired. The name of the resource
projectstringRequired. The project to add the resource to
templatebooleanfalseGenerate a @ResourceTemplate with URI template params
directorystringSubdirectory within src/resources/

Generated Code

import { Resource, ResourceContext } from '@frontmcp/sdk';

@Resource({
  name: 'user-profile',
  uri: 'user-profile://data',
  description: 'TODO: describe this resource',
  mimeType: 'application/json',
})
export default class UserProfileResource extends ResourceContext {
  async execute(uri: string) {
    return {
      contents: [{ uri, mimeType: 'application/json', text: JSON.stringify({}) }],
    };
  }
}