stack/docs
Madison 8abf9472f2
mcp server and mcp browser for testing (#821)
<!--

Make sure you've read the CONTRIBUTING.md guidelines:
https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md

-->

<!-- ELLIPSIS_HIDDEN -->


----

> [!IMPORTANT]
> Introduces an interactive documentation browser and MCP server for
testing, with new API handling and enriched API spec display.
> 
>   - **New Features**:
> - Adds `route.ts` to handle API requests for listing and retrieving
documentation using MCP.
> - Implements `McpBrowserPage` in `page.tsx` for interactive
documentation browsing.
> - Displays full documentation content and enriched API specs for API
pages.
>   - **Dependencies**:
> - Adds `@modelcontextprotocol/sdk`, `@vercel/mcp-adapter`, and
`posthog-node` to `package.json`.
>   - **Misc**:
>     - Integrates PostHog for analytics in `route.ts`.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup>
for a80967c8b5. You can
[customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>

----


<!-- ELLIPSIS_HIDDEN -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Interactive documentation browser with list and detail panes,
selection, loading states, and user-friendly error messages.
* Shows full documentation content and, for API pages, enriched OpenAPI
details when available.

* **Chores**
* Added dependencies to enable the documentation browser, MCP backend
integration, and analytics (PostHog).
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-08-11 17:17:41 -05:00
..
lib Update AI chatbot prompt 2025-07-16 13:38:12 -07:00
public Re-add CLI auth docs 2025-07-03 15:43:36 -07:00
scripts fix links and redirect issues on components index page (#796) 2025-07-23 19:13:30 -07:00
src mcp server and mcp browser for testing (#821) 2025-08-11 17:17:41 -05:00
templates Remove unneeded Lucide icons 2025-08-02 21:57:35 -07:00
templates-api New docs (#698) 2025-06-20 13:30:01 -07:00
templates-python Docs updates (#753) 2025-07-11 10:00:02 -07:00
.env.development New docs (#698) 2025-06-20 13:30:01 -07:00
.eslintrc.json New docs (#698) 2025-06-20 13:30:01 -07:00
.gitignore Docs updates (#753) 2025-07-11 10:00:02 -07:00
CHANGELOG.md chore: update package versions 2025-08-06 12:05:10 -07:00
cli.json New docs (#698) 2025-06-20 13:30:01 -07:00
docs-platform.yml Docs updates (#753) 2025-07-11 10:00:02 -07:00
middleware.ts Docs updates (#753) 2025-07-11 10:00:02 -07:00
next.config.mjs Add API docs to llms.txt file. (#766) 2025-07-15 11:13:32 -05:00
package.json mcp server and mcp browser for testing (#821) 2025-08-11 17:17:41 -05:00
postcss.config.mjs New docs (#698) 2025-06-20 13:30:01 -07:00
README.md New docs (#698) 2025-06-20 13:30:01 -07:00
source.config.ts New docs (#698) 2025-06-20 13:30:01 -07:00
tsconfig.json New docs (#698) 2025-06-20 13:30:01 -07:00

stack-docs

This is a Next.js application generated with Create Fumadocs.

Run development server:

npm run dev
# or
pnpm dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Explore

In the project, you can see:

  • lib/source.ts: Code for content source adapter, loader() provides the interface to access your content.
  • app/layout.config.tsx: Shared options for layouts, optional but preferred to keep.
Route Description
app/(home) The route group for your landing page and other pages.
app/docs The documentation layout and pages.
app/api The documentation for API pages.
app/api/search/route.ts The Route Handler for search.

Fumadocs MDX

A source.config.ts config file has been included, you can customise different options like frontmatter schema.

Read the Introduction for further details.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources: