Basic Usage
Signature
Type Safety
The@Resource decorator validates at compile time that the decorated class extends ResourceContext. Using it on a plain class produces a descriptive compile error.
The same applies to @ResourceTemplate.
Configuration Options
Required Properties
| Property | Type | Description |
|---|---|---|
name | string | Unique resource identifier |
uri | string | Resource URI (must be valid per RFC 3986) |
Optional Properties
| Property | Type | Description |
|---|---|---|
title | string | Human-readable title |
description | string | Resource description |
mimeType | string | MIME type (e.g., ‘application/json’) |
icons | Icon[] | Icons for display |
availableWhen | EntryAvailability | Environment availability constraint |
URI Schemes
Resources can use any valid URI scheme:Return Format
Resources must returnReadResourceResult:
Text Content
Binary Content
Function-Based Alternative
Context Methods
TheResourceContext base class provides:
Full Example
Related
@ResourceTemplate
Dynamic URI templates
ResourceContext
Context class details
ResourceRegistry
Resource registry API
Resource Errors
Resource-related errors