Groups & organization

Groups and Tags

Organize your resources with group and tags for categorization. These fields work the same way as for tools.

import { defineMcpResource } from '@nuxtjs/mcp-toolkit/server'

export default defineMcpResource({
  group: 'config',
  tags: ['readonly', 'settings'],
  description: 'Application settings',
  file: 'config/app.json',
})

You can also place resource files in subdirectories to auto-infer the group:

server/mcp/resources/
├── config/
│   └── app-settings.ts   → group: 'config'
├── docs/
│   └── readme.ts         → group: 'docs'
└── schema.ts             → no group

File Organization

Organize your resources in the server/mcp/resources/ directory. Both flat and nested layouts are supported:

server/
└── mcp/
    └── resources/
        ├── readme.ts
        ├── file.ts
        └── config/
            └── app-settings.ts

Each file should export a default resource definition. Subdirectories automatically set the group.

URI Schemes

You can use any URI scheme that makes sense for your use case:

• file:// - File system resources
• api:// - API endpoints
• http:// / https:// - Web resources
• custom:// - Custom schemes

Conditional Registration

You can control whether a resource is visible to clients using the enabled guard:

export default defineMcpResource({
  name: 'internal-data',
  uri: 'app://internal',
  enabled: event => event.context.user?.role === 'admin',
  handler: async (uri) => ({
    contents: [{ uri: uri.toString(), text: 'Internal data...' }],
  }),
})

Next Steps

• Tools - Create tools to perform actions
• Prompts - Create reusable prompts
• Handlers - Create custom MCP endpoints
• Dynamic Definitions - Conditionally register definitions
• Examples - More resource examples