Skip to content

Fix page-actions example, add subtitle/description table, add MCP "How … #6831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix page-actions example, add subtitle/description table, add MCP "How … #6831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions fern/products/docs/pages/ai/mcp-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This is the server your readers connect to, and it serves your content. To point

Your MCP server is available at `your-documentation-site.com/_mcp/server`. For example, the MCP server for this site is at [https://buildwithfern.com/learn/_mcp/server](https://buildwithfern.com/learn/_mcp/server).

## How it works

The MCP server exposes a single tool: a semantic search tool that lets AI clients query your documentation. The client sends a natural-language question and the server returns the most relevant passages from your docs, along with their source URLs. The search is vector-based, not keyword-based, so the server finds conceptually relevant content even when the exact words don't match.

Each query to the MCP server counts as one Ask AI query against your plan's Ask AI usage. Monitor usage in the [Fern Dashboard](https://dashboard.buildwithfern.com/) under **Ask Fern**.

## Connect to your MCP server

For Claude Code and Cursor, [page action](/learn/docs/configuration/site-level-settings#page-actions-configuration) buttons let users connect in one click:
Expand Down
8 changes: 8 additions & 0 deletions fern/products/docs/pages/navigation/frontmatter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,14 @@ navigation:

`subtitle` and `description` are closely related but serve different purposes: `subtitle` is visible on the page, while `description` is metadata for search engines and social previews. When `description` is missing, Fern falls back to `subtitle` for the metadata; a missing `subtitle` simply renders nothing.

| Field | Visible on page? | Used as meta description? | Used as OG description? |
|---|---|---|---|
| `subtitle` | Yes | Fallback when `description` is absent | Fallback when `description` and `og:description` are absent |
| `description` | No | Yes | Fallback when `og:description` is absent |
| `og:description` | No | No | Yes |

This differs from Mintlify, where `description` is the visible subtitle and `og:description` is the meta description. In Fern, `subtitle` is the visible field and `description` is the meta field.

<Tabs>
<Tab title="MDX">
<CodeBlock title="Example subtitle and description">
Expand Down
8 changes: 4 additions & 4 deletions fern/products/docs/pages/navigation/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,11 +843,11 @@ To hide page actions on an individual page, use the [`hide-page-actions` frontma

```yaml docs.yml
page-actions:
default: cursor
default: cursor # cursor is shown as the primary action
options:
copy-page: false
ask-ai: false
cursor: true
copy-page: false # disable the Copy Page button
ask-ai: false # disable the Ask AI button
cursor: true # keep Cursor enabled (independent of default)
```

<ParamField path="page-actions.default" type="string" required={false} toc={true}>
Expand Down
Loading