---
title: "@affordances/md/next · Affordances"
description: "Affordances gives every page of a Next.js app a JSON view for agents, and turns one action definition into a server action, an HTTP endpoint, a WebMCP tool, and an MCP tool."
url: "https://affordances.vercel.app/docs/reference/api-reference/md/next"
image: "https://affordances.vercel.app/og/docs/reference/api-reference/md/next"
lang: "en"
---

# @affordances/md/next

## Type Aliases

### Config

```ts
type Config = object;
```

#### Properties

##### rewrites?

```ts
rewrites?: () => Promise<unknown> | unknown;
```

###### Returns

`Promise`<`unknown`> | `unknown`

---

### Has

```ts
type Has = object;
```

#### Properties

##### key

```ts
key: string;
```

##### type

```ts
type: "header" | "query";
```

##### value?

```ts
value?: string;
```

---

### LlmsFullOptions

```ts
type LlmsFullOptions = Omit<MdHandlerOptions, "append"> & object;
```

#### Type Declaration

| Name     | Type                                                                                 |
| -------- | ------------------------------------------------------------------------------------ |
| `pages?` | [`Pages`](https://affordances.vercel.app/docs/reference/api-reference/md/next#pages) |

---

### LlmsLink

```ts
type LlmsLink = 
  | string
  | {
  description?: string;
  title: string;
  url: string;
};
```

---

### LlmsTxtOptions

```ts
type LlmsTxtOptions = Omit<MdHandlerOptions, "append"> & object;
```

#### Type Declaration

| Name          | Type                                                           |
| ------------- | -------------------------------------------------------------- |
| `full?`       | `string` \| `false`                                            |
| `intro?`      | `string`                                                       |
| `sections()?` | (`request`, `routes`) => `object`\[] \| `Promise`<`object`\[]> |
| `summary?`    | `string`                                                       |
| `title?`      | `string`                                                       |

---

### MdHandlerOptions

```ts
type MdHandlerOptions = object;
```

#### Properties

##### append?

```ts
append?: (request) => Promise<string | undefined> | string | undefined;
```

###### Parameters

| Parameter | Type      |
| --------- | --------- |
| `request` | `Request` |

###### Returns

`Promise`<`string` | `undefined`> | `string` | `undefined`

##### maxBytes?

```ts
maxBytes?: number;
```

##### origin?

```ts
origin?: string;
```

##### timeout?

```ts
timeout?: number;
```

---

### Pages

```ts
type Pages = (request, routes) => string[] | Promise<string[]>;
```

#### Parameters

| Parameter | Type        |
| --------- | ----------- |
| `request` | `Request`   |
| `routes`  | `string`\[] |

#### Returns

`string`\[] | `Promise`<`string`\[]>

---

### Rewrite

```ts
type Rewrite = object;
```

#### Properties

##### destination

```ts
destination: string;
```

##### has?

```ts
has?: Has[];
```

##### missing?

```ts
missing?: Has[];
```

##### source

```ts
source: string;
```

---

### Rewrites

```ts
type Rewrites = object;
```

#### Properties

##### afterFiles

```ts
afterFiles: Rewrite[];
```

##### beforeFiles

```ts
beforeFiles: Rewrite[];
```

##### fallback

```ts
fallback: Rewrite[];
```

## Variables

### GET

```ts
const GET: (request) => Promise<Response>;
```

#### Parameters

| Parameter | Type      |
| --------- | --------- |
| `request` | `Request` |

#### Returns

`Promise`<`Response`>

---

### MD_PATH

```ts
const MD_PATH: "/api/affordances/md" = '/api/affordances/md';
```

---

### RENDER_HEADER

```ts
const RENDER_HEADER: "x-affordances-md-render" = 'x-affordances-md-render';
```

---

### rewrites

```ts
const rewrites: object;
```

#### Type Declaration

| Name          | Type        |
| ------------- | ----------- |
| `afterFiles`  | `object`\[] |
| `beforeFiles` | `object`\[] |

## Functions

### createLlmsFullHandler()

```ts
function createLlmsFullHandler(__namedParameters?): (request) => Promise<Response>;
```

#### Parameters

| Parameter            | Type                                                                                                     |
| -------------------- | -------------------------------------------------------------------------------------------------------- |
| `__namedParameters?` | [`LlmsFullOptions`](https://affordances.vercel.app/docs/reference/api-reference/md/next#llmsfulloptions) |

#### Returns

(`request`) => `Promise`<`Response`>

---

### createLlmsTxtHandler()

```ts
function createLlmsTxtHandler(__namedParameters?): (request) => Promise<Response>;
```

#### Parameters

| Parameter            | Type                                                                                                   |
| -------------------- | ------------------------------------------------------------------------------------------------------ |
| `__namedParameters?` | [`LlmsTxtOptions`](https://affordances.vercel.app/docs/reference/api-reference/md/next#llmstxtoptions) |

#### Returns

(`request`) => `Promise`<`Response`>

---

### createMdHandler()

```ts
function createMdHandler(__namedParameters?): (request) => Promise<Response>;
```

#### Parameters

| Parameter            | Type                                                                                                       |
| -------------------- | ---------------------------------------------------------------------------------------------------------- |
| `__namedParameters?` | [`MdHandlerOptions`](https://affordances.vercel.app/docs/reference/api-reference/md/next#mdhandleroptions) |

#### Returns

(`request`) => `Promise`<`Response`>

---

### md()

```ts
function md(): <C>(config) => C;
```

#### Returns

<`C`>(`config`) => `C`

---

### mdAlternate()

```ts
function mdAlternate(path): object;
```

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `path`    | `string` |

#### Returns

`object`

| Name                  | Type     |
| --------------------- | -------- |
| `types`               | `object` |
| `types.text/markdown` | `string` |

---

### withMd()

```ts
function withMd<C>(config): C;
```

#### Type Parameters

| Type Parameter                                                                                       |
| ---------------------------------------------------------------------------------------------------- |
| `C` _extends_ [`Config`](https://affordances.vercel.app/docs/reference/api-reference/md/next#config) |

#### Parameters

| Parameter | Type |
| --------- | ---- |
| `config`  | `C`  |

#### Returns

`C`