> ## Documentation Index
> Fetch the complete documentation index at: https://fastmcp-ts.docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ResourceConfig

Defined in: [server/resource.ts:16](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L16)

## Properties

### annotations?

```ts theme={null}
optional annotations?: ResourceAnnotations;
```

Defined in: [server/resource.ts:32](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L32)

Behavioral hints for clients.

***

### auth?

```ts theme={null}
optional auth?: AuthCheck;
```

Defined in: [server/resource.ts:39](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L39)

***

### complete?

```ts theme={null}
optional complete?: Record<string, CompleteCallback>;
```

Defined in: [server/resource.ts:49](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L49)

Autocompletion callbacks for this resource template's RFC 6570 variables,
keyed by variable name. Only meaningful for URI templates. When set, a
`completion/complete` request for
`{ ref: { type: 'ref/resource', uri: <this template> }, argument: { name, value } }`
routes to `complete[name]`.

***

### description?

```ts theme={null}
optional description?: string;
```

Defined in: [server/resource.ts:23](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L23)

***

### disabled?

```ts theme={null}
optional disabled?: boolean;
```

Defined in: [server/resource.ts:36](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L36)

When true the resource is hidden from list responses and cannot be read.

***

### mimeType?

```ts theme={null}
optional mimeType?: string;
```

Defined in: [server/resource.ts:25](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L25)

MIME type of the resource content. Defaults to 'text/plain' for strings, 'application/octet-stream' for binary.

***

### name?

```ts theme={null}
optional name?: string;
```

Defined in: [server/resource.ts:20](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L20)

Programmatic identifier. Defaults to the uri.

***

### size?

```ts theme={null}
optional size?: number;
```

Defined in: [server/resource.ts:30](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L30)

Size of the resource content in bytes, if known.
Only meaningful for static resources; ignored for URI templates.

***

### tags?

```ts theme={null}
optional tags?: string[];
```

Defined in: [server/resource.ts:38](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L38)

Arbitrary tags for server-side filtering.

***

### timeout?

```ts theme={null}
optional timeout?: number;
```

Defined in: [server/resource.ts:34](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L34)

Execution timeout in milliseconds. No timeout by default.

***

### title?

```ts theme={null}
optional title?: string;
```

Defined in: [server/resource.ts:22](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L22)

Human-readable display name shown in UIs. Defaults to `name`.

***

### ui?

```ts theme={null}
optional ui?: ResourceUiMeta;
```

Defined in: [server/resource.ts:41](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L41)

Apps extension metadata. Included in \_meta.ui in resources/list for UI-capable clients.

***

### uri

```ts theme={null}
uri: string;
```

Defined in: [server/resource.ts:18](https://github.com/PrefectHQ/fastmcp-ts/blob/e4b6038f642b529f601463a576229747afebe9a4/src/server/resource.ts#L18)

Static URI (e.g. `file://readme`) or RFC 6570 template (e.g. `user://{id}`).
