# WebMCP Documentation

> WebMCP is a W3C standard for making websites AI-accessible. It defines the Web Model Context API (`navigator.modelContext`), enabling any website to register tools, prompts, and resources that work with Claude, ChatGPT, and custom AI agents.

## Quick Start

Add WebMCP to any website with one script tag:

```html
<script src="https://unpkg.com/@mcp-b/global@latest/dist/index.iife.js" defer></script>
<script>
  navigator.modelContext.registerTool({
    name: 'get_weather',
    description: 'Get weather for a city',
    inputSchema: { type: 'object', properties: { city: { type: 'string' } }, required: ['city'] },
    handler: async ({ city }) => ({ content: [{ type: 'text', text: `Weather in ${city}: 72F, sunny` }] })
  });
</script>
```

Or with npm:

```bash
npm install @mcp-b/global
```

```typescript
import '@mcp-b/global';

navigator.modelContext.registerTool({
  name: 'get_weather',
  description: 'Get weather for a city',
  inputSchema: { type: 'object', properties: { city: { type: 'string' } }, required: ['city'] },
  handler: async ({ city }) => ({ content: [{ type: 'text', text: `Weather in ${city}: 72F, sunny` }] })
});
```

## Core Concepts

### Web Model Context API
`navigator.modelContext` is the browser-native API (proposed W3C standard) for AI tool registration. WebMCP polyfills this API for browsers that don't support it natively yet.

### Tool Registration
Tools are functions that AI agents can call. Register them with `navigator.modelContext.registerTool()`. Each tool has a name, description, JSON Schema input, and an async handler.

### Prompts
Prompts are predefined message templates. Register with `navigator.modelContext.registerPrompt()`. Useful for standardizing how agents interact with your application.

### Resources
Resources expose data to agents. Register with `navigator.modelContext.registerResource()`. Think of them as read-only data endpoints.

### Transports
Transports connect your website's tools to AI agents. Available transports:
- **Tab Transport**: Extension communicates with the page via Chrome tabs API
- **Iframe Transport**: Parent-child iframe communication
- **Chrome DevTools MCP**: Connect Claude Code or other MCP clients via Chrome DevTools Protocol

### Package Layering
```
@mcp-b/global              → Entry point, auto-initializes
@mcp-b/webmcp-ts-sdk       → BrowserMcpServer with MCP extensions
@mcp-b/webmcp-polyfill      → Polyfills navigator.modelContext
Native browser API           → navigator.modelContext (when available)
```

## How Agents Connect

1. **AI Browsers**: Chrome with built-in AI, Perplexity browser — native `navigator.modelContext` support
2. **Browser Extension**: MCP-B extension connects any MCP client to page tools
3. **Embedded Agent**: Drop-in `<char-agent>` component for in-page AI assistants
4. **Chrome DevTools MCP**: Connect Claude Code, Cursor, or any MCP client via DevTools Protocol

## NPM Packages

| Package | Purpose |
|---------|---------|
| `@mcp-b/global` | Entry point — polyfill + BrowserMcpServer auto-setup |
| `@mcp-b/webmcp-polyfill` | Polyfills `navigator.modelContext` for non-native browsers |
| `@mcp-b/webmcp-ts-sdk` | BrowserMcpServer with full MCP capabilities |
| `@mcp-b/webmcp-types` | TypeScript types for the Web Model Context API |
| `@mcp-b/react-webmcp` | React hooks (`useWebMCP`) for tool registration |
| `@mcp-b/transports` | Tab and iframe transport implementations |
| `@mcp-b/mcp-iframe` | Iframe-based MCP communication |
| `@mcp-b/chrome-devtools-mcp` | Connect MCP clients via Chrome DevTools Protocol |
| `@mcp-b/extension-tools` | Utilities for the browser extension |
| `@mcp-b/smart-dom-reader` | Intelligent DOM content extraction |

## Framework Support

WebMCP works with any JavaScript framework:
- **React**: `@mcp-b/react-webmcp` with `useWebMCP` hook
- **Vue**: Direct `navigator.modelContext.registerTool()` in `onMounted`
- **Svelte**: Direct API in `onMount`
- **Angular**: Direct API in `ngOnInit`
- **TanStack Start / Remix**: React hook approach
- **Rails (Stimulus)**: Direct API in `connect()`
- **Phoenix LiveView**: Direct API in `mounted()` hook

## Documentation Sitemap

### Getting Started
- [Introduction](/introduction): What is WebMCP and why it matters
- [Quickstart](/quickstart): Get running in 5 minutes
- [Examples](/examples): Code examples overview

### Guides
- [Best Practices](/best-practices): Patterns for effective tool design
- [Development](/development): Local development workflow
- [Advanced](/advanced): Advanced patterns and techniques
- [Building MCP UI Apps](/building-mcp-ui-apps): Full application patterns
- [Security](/security): Security model and best practices

### Framework Guides
- [Overview](/frameworks/index): Framework integration overview
- [React](/frameworks/react) | [Vue](/frameworks/vue) | [Svelte](/frameworks/svelte) | [Angular](/frameworks/angular)
- [TanStack Start](/frameworks/tanstack-start) | [Remix](/frameworks/remix) | [Nuxt](/frameworks/nuxt)
- [Rails](/frameworks/rails) | [Phoenix LiveView](/frameworks/phoenix-liveview)

### Calling Tools (Agent Connection)
- [Overview](/calling-tools/index): How agents discover and call tools
- [Embedded Agent](/calling-tools/embedded-agent): Drop-in AI chat component
- [AI Browsers](/calling-tools/ai-browsers): Native browser support
- [Extension](/calling-tools/extension): MCP-B browser extension
- [DevTools MCP](/calling-tools/devtools-mcp): Chrome DevTools Protocol bridge

### Concepts
- [Overview](/concepts/overview) | [Why WebMCP](/concepts/why-webmcp) | [Architecture](/concepts/architecture)
- [Tool Registration](/concepts/tool-registration) | [Prompts](/concepts/prompts) | [Resources](/concepts/resources)
- [Transports](/concepts/transports) | [Context Engineering](/concepts/context-engineering)
- [MCP UI Integration](/concepts/mcp-ui-integration) | [Extension](/concepts/extension) | [Schemas](/concepts/schemas)
- [Tool Design](/concepts/tool-design) | [Performance](/concepts/performance) | [Glossary](/concepts/glossary)

### NPM Package Reference
- [@mcp-b/global](/packages/global) | [@mcp-b/transports](/packages/transports)
- [@mcp-b/mcp-iframe](/packages/mcp-iframe) | [@mcp-b/react-webmcp](/packages/react-webmcp)
- [@mcp-b/chrome-devtools-mcp](/packages/chrome-devtools-mcp) | [@mcp-b/extension-tools](/packages/extension-tools)
- [@mcp-b/webmcp-ts-sdk](/packages/webmcp-ts-sdk) | [@mcp-b/smart-dom-reader](/packages/smart-dom-reader)

### Extension
- [Overview](/extension/index) | [Agents](/extension/agents) | [Userscripts](/extension/managing-userscripts)
- [Native Host Setup](/native-host-setup)

### Reference
- [Changelog](/changelog) | [Troubleshooting](/troubleshooting) | [Claude Code](/tools/claude-code)

### For AI
- [MCP Integration](/mcp-integration) | [llms.txt](/llms-txt)

### Live Examples
- [Tools](/live-tool-examples) | [Prompts](/live-prompt-examples) | [Resources](/live-resource-examples)

## Support

- Documentation: https://docs.mcp-b.ai
- GitHub: https://github.com/WebMCP-org
- NPM Packages: https://github.com/WebMCP-org/npm-packages
- Examples: https://github.com/WebMCP-org/examples
- Discord: https://discord.gg/ZnHG4csJRB
- Live Demo: https://webmcp.sh


# Mintlify

## Docs

- [Customize agent behavior](https://www.mintlify.com/docs/agent/customize.md): Configure how the agent handles documentation tasks with AGENTS.md.
- [Write effective prompts](https://www.mintlify.com/docs/agent/effective-prompts.md): Get better results from the agent with clear, focused prompts.
- [What is the agent?](https://www.mintlify.com/docs/agent/index.md): Automate documentation updates with the agent. Create updates from Slack messages, PRs, or API calls.
- [Add the agent to Slack](https://www.mintlify.com/docs/agent/slack.md): Use the agent in Slack to make documentation updates from conversations and capture team knowledge.
- [Use cases](https://www.mintlify.com/docs/agent/use-cases.md): Examples of using the agent in your documentation process.
- [Workflows](https://www.mintlify.com/docs/agent/workflows.md): Automate documentation maintenance with scheduled or event-triggered agent tasks.
- [AI-native documentation](https://www.mintlify.com/docs/ai-native.md): Learn how AI enhances reading, writing, and discovering your documentation
- [Assistant](https://www.mintlify.com/docs/ai/assistant.md): Add AI-powered chat to your docs that answers questions, cites sources, and generates code examples.
- [Contextual menu](https://www.mintlify.com/docs/ai/contextual-menu.md): Add a contextual menu to your docs with one-click AI integrations for ChatGPT, Claude, Perplexity, and MCP tools.
- [Discord bot](https://www.mintlify.com/docs/ai/discord.md): Add a bot to your Discord server that answers questions based on your documentation.
- [llms.txt](https://www.mintlify.com/docs/ai/llmstxt.md): Automatically generate llms.txt and llms-full.txt files to help AI tools index and understand your documentation.
- [Markdown export](https://www.mintlify.com/docs/ai/markdown-export.md): Quickly get Markdown versions of pages for AI tools and integrations.
- [Model Context Protocol](https://www.mintlify.com/docs/ai/model-context-protocol.md): Connect your documentation and API endpoints to AI tools with a hosted MCP server.
- [skill.md](https://www.mintlify.com/docs/ai/skillmd.md): Make your documentation agent-ready with automatically generated skill.md files that describe your product's capabilities for AI agents.
- [Slack bot](https://www.mintlify.com/docs/ai/slack-bot.md): Add a bot to your Slack workspace that answers questions based on your documentation.
- [Add SDK examples](https://www.mintlify.com/docs/api-playground/adding-sdk-examples.md): Display SDK code samples in your API documentation.
- [AsyncAPI setup](https://www.mintlify.com/docs/api-playground/asyncapi-setup.md): Create websocket documentation with AsyncAPI specifications.
- [Complex data types](https://www.mintlify.com/docs/api-playground/complex-data-types.md): Describe APIs with flexible schemas, optional properties, and multiple data formats using `oneOf`, `anyOf`, and `allOf` keywords.
- [Manage page visibility](https://www.mintlify.com/docs/api-playground/managing-page-visibility.md): Control which API endpoints appear in your documentation navigation.
- [Create manual API pages](https://www.mintlify.com/docs/api-playground/mdx-setup.md): Create API reference pages manually with MDX files for small APIs, prototypes, or custom documentation needs.
- [Multiple responses](https://www.mintlify.com/docs/api-playground/multiple-responses.md): Document multiple response variations for API endpoints.
- [OpenAPI setup](https://www.mintlify.com/docs/api-playground/openapi-setup.md): Generate interactive API documentation from your OpenAPI specification files.
- [Playground](https://www.mintlify.com/docs/api-playground/overview.md): Let developers test API endpoints directly in your documentation.
- [Troubleshooting](https://www.mintlify.com/docs/api-playground/troubleshooting.md): Resolve common issues with API page configuration.
- [Create agent job](https://www.mintlify.com/docs/api/agent/create-agent-job.md): Create an agent job to automate documentation updates, with automatic branch creation and pull request generation.
- [Get agent job](https://www.mintlify.com/docs/api/agent/get-agent-job.md): Retrieve the status and details of a specific agent job, including progress, branch info, and pull request details.
- [List agent jobs](https://www.mintlify.com/docs/api/agent/get-all-jobs.md): Retrieve all agent jobs for a project to monitor activities and track historical job statuses.
- [Get assistant conversations](https://www.mintlify.com/docs/api/analytics/assistant-conversations.md): Retrieve AI assistant conversation history including queries, responses, cited sources, and categories.
- [Get feedback](https://www.mintlify.com/docs/api/analytics/feedback.md): Retrieve user feedback from your documentation, including page ratings and code snippet feedback.
- [Create assistant message](https://www.mintlify.com/docs/api/assistant/create-assistant-message-v2.md): Send messages to the AI assistant and receive streaming responses using AI SDK v5 or later with the useChat hook.
- [Search documentation](https://www.mintlify.com/docs/api/assistant/search.md): Search your documentation programmatically and retrieve relevant pages matching the query.
- [Introduction](https://www.mintlify.com/docs/api/introduction.md): Trigger updates, embed AI assistant, export analytics, and more
- [Get deployment status](https://www.mintlify.com/docs/api/update/status.md): Check the status of a documentation deployment to monitor progress and completion.
- [Trigger deployment](https://www.mintlify.com/docs/api/update/trigger.md): Trigger a documentation deployment programmatically to publish updates outside of Git workflows.
- [Accordions](https://www.mintlify.com/docs/components/accordions.md): Use accordions to show and hide content sections, organize information, and enable progressive disclosure in your documentation.
- [Badge](https://www.mintlify.com/docs/components/badge.md): Use badges to highlight status, labels, or metadata inline or standalone.
- [Banner](https://www.mintlify.com/docs/components/banner.md): Add a banner to display important site-wide announcements and notifications.
- [Callouts](https://www.mintlify.com/docs/components/callouts.md): Use callouts to style and emphasize important content.
- [Cards](https://www.mintlify.com/docs/components/cards.md): Highlight main points or links with customizable layouts and icons.
- [Code groups](https://www.mintlify.com/docs/components/code-groups.md): Display multiple code examples in a tabbed interface to compare implementations across different languages.
- [Color](https://www.mintlify.com/docs/components/color.md): Display color palettes with click-to-copy capability.
- [Columns](https://www.mintlify.com/docs/components/columns.md): Arrange cards and other components in a responsive grid layout with customizable column counts.
- [Examples](https://www.mintlify.com/docs/components/examples.md): Display code blocks in the right sidebar on desktop devices
- [Expandables](https://www.mintlify.com/docs/components/expandables.md): Toggle expandable sections to show and hide nested object properties in API documentation and response fields.
- [Fields](https://www.mintlify.com/docs/components/fields.md): Document API request and response parameters with type information.
- [Frames](https://www.mintlify.com/docs/components/frames.md): Add visual emphasis with styled frames around images and other components.
- [Icons](https://www.mintlify.com/docs/components/icons.md): Use icons from popular libraries, external URLs, or files in your project.
- [Overview](https://www.mintlify.com/docs/components/index.md): Component library for layout, emphasis, API documentation, and navigation.
- [Mermaid](https://www.mintlify.com/docs/components/mermaid-diagrams.md): Create flowcharts, diagrams, and visualizations with Mermaid syntax.
- [Panel](https://www.mintlify.com/docs/components/panel.md): Customize the content of the right side panel on a page.
- [Prompt](https://www.mintlify.com/docs/components/prompt.md): Display pre-built AI prompts with copy and Cursor integration actions.
- [Response fields](https://www.mintlify.com/docs/components/responses.md): Document API response fields with type information, descriptions, and required/optional indicators.
- [Steps](https://www.mintlify.com/docs/components/steps.md): Create numbered step-by-step procedures with visual indicators to guide users through sequential tasks and tutorials.
- [Tabs](https://www.mintlify.com/docs/components/tabs.md): Organize content with tabs to show different options or versions.
- [Tiles](https://www.mintlify.com/docs/components/tiles.md): Display visual previews with titles and descriptions in a grid layout.
- [Tooltips](https://www.mintlify.com/docs/components/tooltips.md): Add contextual help with hover tooltips for terms and concepts.
- [Tree](https://www.mintlify.com/docs/components/tree.md): Use tree components to display hierarchical file and folder structures.
- [Update](https://www.mintlify.com/docs/components/update.md): Display product updates and changelog entries in a timeline format.
- [View](https://www.mintlify.com/docs/components/view.md): Create multi-view content for different programming languages or frameworks.
- [Changelogs](https://www.mintlify.com/docs/create/changelogs.md): Create product changelogs with RSS feed support for subscribers.
- [Format code](https://www.mintlify.com/docs/create/code.md): Display inline code and code blocks with syntax highlighting, line numbers, diffs, and interactive features.
- [Files](https://www.mintlify.com/docs/create/files.md): Serve static assets like images, videos, PDFs, and data files directly from your documentation repository.
- [Images and embeds](https://www.mintlify.com/docs/create/image-embeds.md): Add images, embed YouTube videos, and include iframes to enhance your documentation with visual and interactive content.
- [Lists and tables](https://www.mintlify.com/docs/create/list-table.md): Format structured data with Markdown tables, ordered lists, unordered lists, and nested list structures.
- [Personalized content](https://www.mintlify.com/docs/create/personalization.md): Show custom content based on user data and authentication.
- [Redirects](https://www.mintlify.com/docs/create/redirects.md): Configure redirects for moved, renamed, or deleted pages.
- [Reusable snippets](https://www.mintlify.com/docs/create/reusable-snippets.md): Create reusable snippets to maintain consistency across pages.
- [Format text](https://www.mintlify.com/docs/create/text.md): Learn how to format text, create headers, and style content.
- [Custom 404 page](https://www.mintlify.com/docs/customize/custom-404-page.md): Customize the title and description of your 404 error page.
- [Custom domain](https://www.mintlify.com/docs/customize/custom-domain.md): Host your documentation on a custom domain by configuring DNS settings and automatic TLS certificate provisioning.
- [Custom scripts](https://www.mintlify.com/docs/customize/custom-scripts.md): Add custom JavaScript and CSS to fully customize the look and feel of your documentation.
- [Fonts](https://www.mintlify.com/docs/customize/fonts.md): Customize typography with Google Fonts or self-hosted fonts.
- [React](https://www.mintlify.com/docs/customize/react-components.md): Build interactive and reusable elements with React components.
- [Themes](https://www.mintlify.com/docs/customize/themes.md): Choose a theme to customize the appearance of your documentation.
- [Audit logs](https://www.mintlify.com/docs/dashboard/audit-logs.md): Review the actions that members of your organization perform.
- [Deployment permissions](https://www.mintlify.com/docs/dashboard/permissions.md): Understand deployment differences between people in your organization and other contributors.
- [Roles](https://www.mintlify.com/docs/dashboard/roles.md): Assign admin, editor, or viewer roles to manage team access and permissions.
- [Security contact](https://www.mintlify.com/docs/dashboard/security-contact.md): Set an email address for communications related to customer and platform security.
- [Single sign-on (SSO)](https://www.mintlify.com/docs/dashboard/sso.md): Set up SAML or OIDC with identity providers for team authentication.
- [Authentication setup](https://www.mintlify.com/docs/deploy/authentication-setup.md): Control access to your documentation by authenticating users.
- [CI checks](https://www.mintlify.com/docs/deploy/ci.md): Automate broken link checks, linting, and grammar validation in CI/CD.
- [Cloudflare](https://www.mintlify.com/docs/deploy/cloudflare.md): Host documentation at a subpath on Cloudflare Workers.
- [Content Security Policy (CSP) configuration](https://www.mintlify.com/docs/deploy/csp-configuration.md): Configure CSP headers to allow Mintlify resources while maintaining security for reverse proxies, firewalls, and networks that enforce strict security policies.
- [Deployments](https://www.mintlify.com/docs/deploy/deployments.md): Manage deployments, view history, and monitor status.
- [Overview](https://www.mintlify.com/docs/deploy/docs-subpath.md): Host your documentation at the `/docs` subpath on your domain.
- [GitHub Enterprise Server](https://www.mintlify.com/docs/deploy/ghes.md): Set up the GitHub App on your GitHub Enterprise Server installation.
- [GitHub](https://www.mintlify.com/docs/deploy/github.md): Connect to a GitHub repository for automated deployments, pull request previews, and continuous synchronization.
- [GitLab](https://www.mintlify.com/docs/deploy/gitlab.md): Connect to a GitLab repository for automated deployments and preview builds.
- [Monorepo setup](https://www.mintlify.com/docs/deploy/monorepo.md): Configure documentation path and content directory for monorepo projects.
- [Preview deployments](https://www.mintlify.com/docs/deploy/preview-deployments.md): Get unique preview URLs for pull requests to review changes before merging.
- [Reverse proxy](https://www.mintlify.com/docs/deploy/reverse-proxy.md): Configure a custom reverse proxy to serve your documentation.
- [AWS Route 53 and CloudFront](https://www.mintlify.com/docs/deploy/route53-cloudfront.md): Deploy documentation at a subpath on AWS with Route 53 DNS and CloudFront CDN.
- [Vercel](https://www.mintlify.com/docs/deploy/vercel.md): Configure Vercel rewrites to serve your documentation at a subpath on your main domain.
- [External proxies with Vercel](https://www.mintlify.com/docs/deploy/vercel-external-proxies.md): Configure external proxies in front of your Vercel deployment.
- [Collaborate in the web editor](https://www.mintlify.com/docs/editor/collaborate.md): Work together on documentation with branches, pull requests, preview deployments, and shareable editor links.
- [Comments](https://www.mintlify.com/docs/editor/comments.md): Use comments to leave feedback, ask questions, and discuss changes with your team.
- [Configurations](https://www.mintlify.com/docs/editor/configurations.md): Configure pages, navigation elements, and media using configuration sheets.
- [Git essentials for the web editor](https://www.mintlify.com/docs/editor/git-essentials.md): Understand the version control concepts behind the web editor.
- [Web editor overview](https://www.mintlify.com/docs/editor/index.md): Create, edit, and publish documentation in your browser with visual editing, live preview, and Git sync.
- [Keyboard shortcuts](https://www.mintlify.com/docs/editor/keyboard-shortcuts.md): Reference of keyboard shortcuts for the web editor.
- [Live preview](https://www.mintlify.com/docs/editor/live-preview.md): Preview your documentation site and see changes in real time as you edit.
- [Add media](https://www.mintlify.com/docs/editor/media.md): Upload and use images and assets in your documentation.
- [Organize navigation](https://www.mintlify.com/docs/editor/navigation.md): Organize your documentation structure with the visual navigation editor.
- [Create and edit pages](https://www.mintlify.com/docs/editor/pages.md): Create, edit, and organize documentation pages in the web editor.
- [Publish changes in the web editor](https://www.mintlify.com/docs/editor/publish.md): Save your work and publish changes to your documentation site.
- [Suggestions](https://www.mintlify.com/docs/editor/suggestions.md): Propose text changes as suggestions that teammates can accept or reject without editing the page directly.
- [Accessibility](https://www.mintlify.com/docs/guides/accessibility.md): Create documentation that as many people as possible can use with WCAG compliance.
- [Tutorial: Build an in-app documentation assistant](https://www.mintlify.com/docs/guides/assistant-embed.md): Embed the assistant in your application to answer questions with information from your documentation.
- [Tutorial: Auto-update documentation when code is changed](https://www.mintlify.com/docs/guides/automate-agent.md): Use the agent API to automatically update your documentation.
- [Work with branches](https://www.mintlify.com/docs/guides/branches.md): Create branches to preview changes and collaborate before publishing.
- [Claude Code](https://www.mintlify.com/docs/guides/claude-code.md): Configure Claude Code to write, review, and update your documentation.
- [Content templates](https://www.mintlify.com/docs/guides/content-templates.md): Copy and modify ready-to-use templates for how-to guides, tutorials, explanations, and API references.
- [Content types](https://www.mintlify.com/docs/guides/content-types.md): Choose the right content type for your documentation goals.
- [Cursor](https://www.mintlify.com/docs/guides/cursor.md): Configure Cursor with project rules to write documentation that follows your style guide and uses Mintlify components.
- [Headless docs with a custom frontend](https://www.mintlify.com/docs/guides/custom-frontend.md): Use Mintlify's headless mode with the Astro integration to render your documentation with a fully custom frontend while using Mintlify's content and AI infrastructure.
- [Create developer documentation](https://www.mintlify.com/docs/guides/developer-documentation.md): Build documentation that helps developers integrate with your APIs, SDKs, and tools.
- [GEO guide: Optimize docs for AI search and answer engines](https://www.mintlify.com/docs/guides/geo.md): Optimize your documentation for AI search and answer engines.
- [Git concepts for documentation](https://www.mintlify.com/docs/guides/git-concepts.md): Learn version control and collaboration fundamentals for docs-as-code workflows.
- [Improve your docs](https://www.mintlify.com/docs/guides/improving-docs.md): Use data and metrics to improve your documentation.
- [Guides](https://www.mintlify.com/docs/guides/index.md): Learn how to create effective documentation with best practices and workflows.
- [Internationalization](https://www.mintlify.com/docs/guides/internationalization.md): Set up multi-language documentation to reach global audiences.
- [Create a knowledge base](https://www.mintlify.com/docs/guides/knowledge-base.md): Host your internal knowledge base on Mintlify to consolidate information for your team, improve search, and reduce maintenance burden.
- [Linking](https://www.mintlify.com/docs/guides/linking.md): Learn how to create internal links, reference API endpoints, and maintain link integrity across your documentation.
- [Maintenance](https://www.mintlify.com/docs/guides/maintenance.md): Keep your documentation accurate and up-to-date over time.
- [Media](https://www.mintlify.com/docs/guides/media.md): Use media effectively while managing maintenance burden.
- [Migrating MDX API pages to OpenAPI navigation](https://www.mintlify.com/docs/guides/migrating-from-mdx.md): Migrate to automated OpenAPI generation with flexible navigation.
- [Organize navigation](https://www.mintlify.com/docs/guides/navigation.md): Design information architecture that aligns with user needs.
- [SEO](https://www.mintlify.com/docs/guides/seo.md): Improve SEO to increase documentation discoverability.
- [Style and tone](https://www.mintlify.com/docs/guides/style-and-tone.md): Write effective technical documentation with consistent style.
- [Create a support center](https://www.mintlify.com/docs/guides/support-center.md): Build a self-service support center that helps customers find answers, reduces ticket volume, and improves customer satisfaction.
- [Understand your audience](https://www.mintlify.com/docs/guides/understand-your-audience.md): Keep user goals at the center of your documentation.
- [Windsurf](https://www.mintlify.com/docs/guides/windsurf.md): Configure Windsurf Cascade with workspace rules to write documentation that follows your style guide and standards.
- [Introduction](https://www.mintlify.com/docs/index.md): Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.
- [Install the CLI](https://www.mintlify.com/docs/installation.md): Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site.
- [Adobe Analytics](https://www.mintlify.com/docs/integrations/analytics/adobe.md): Track documentation usage with Adobe Analytics via Adobe Experience Platform Launch.
- [Amplitude](https://www.mintlify.com/docs/integrations/analytics/amplitude.md): Track user behavior and documentation analytics with Amplitude.
- [Clarity](https://www.mintlify.com/docs/integrations/analytics/clarity.md): Track user sessions with Microsoft Clarity analytics.
- [Clearbit](https://www.mintlify.com/docs/integrations/analytics/clearbit.md): Enrich visitor data with Clearbit to identify companies and users visiting your documentation.
- [Fathom](https://www.mintlify.com/docs/integrations/analytics/fathom.md): Track privacy-focused documentation analytics with Fathom using a simple site ID configuration.
- [Google Analytics 4](https://www.mintlify.com/docs/integrations/analytics/google-analytics.md): Track visitor behavior and engagement with Google Analytics.
- [Google Tag Manager](https://www.mintlify.com/docs/integrations/analytics/google-tag-manager.md): Manage analytics tags and events with Google Tag Manager.
- [Heap](https://www.mintlify.com/docs/integrations/analytics/heap.md): Track user interactions and events automatically with Heap analytics for detailed behavior insights.
- [Hightouch](https://www.mintlify.com/docs/integrations/analytics/hightouch.md): Sync documentation analytics data to Hightouch for audience activation and downstream integrations.
- [Hotjar](https://www.mintlify.com/docs/integrations/analytics/hotjar.md): Capture user feedback, session recordings, and heatmaps with Hotjar to understand documentation usage.
- [LogRocket](https://www.mintlify.com/docs/integrations/analytics/logrocket.md): Monitor user sessions, replay interactions, and track errors with LogRocket for debugging and insights.
- [Mixpanel](https://www.mintlify.com/docs/integrations/analytics/mixpanel.md): Track product analytics and user behavior with Mixpanel.
- [Analytics integrations](https://www.mintlify.com/docs/integrations/analytics/overview.md): Connect to analytics platforms to track user engagement and documentation usage.
- [Pirsch](https://www.mintlify.com/docs/integrations/analytics/pirsch.md): Track GDPR-compliant, privacy-focused documentation analytics with Pirsch without cookies or personal data.
- [Plausible](https://www.mintlify.com/docs/integrations/analytics/plausible.md): Track simple, privacy-respecting analytics with Plausible.
- [PostHog](https://www.mintlify.com/docs/integrations/analytics/posthog.md): Track product analytics and feature usage with PostHog.
- [Segment](https://www.mintlify.com/docs/integrations/analytics/segment.md): Send analytics events to Segment and downstream tools.
- [Osano](https://www.mintlify.com/docs/integrations/privacy/osano.md): Manage cookie consent with Osano privacy platform.
- [Privacy integrations](https://www.mintlify.com/docs/integrations/privacy/overview.md): Integrate with data privacy platforms for compliance.
- [Speakeasy](https://www.mintlify.com/docs/integrations/sdks/speakeasy.md): Display autogenerated SDK code samples from Speakeasy in your API playground across multiple languages.
- [Stainless](https://www.mintlify.com/docs/integrations/sdks/stainless.md): Display autogenerated SDK code samples from Stainless in your API playground with type-safe examples.
- [Front](https://www.mintlify.com/docs/integrations/support/front.md): Connect Front chat for customer support conversations.
- [Intercom](https://www.mintlify.com/docs/integrations/support/intercom.md): Add the Intercom chat widget to your documentation for real-time customer messaging and support.
- [Support integrations](https://www.mintlify.com/docs/integrations/support/overview.md): Integrate with support platforms for customer assistance.
- [Migrate to Mintlify](https://www.mintlify.com/docs/migration.md): Learn how to migrate to Mintlify from Docusaurus, ReadMe, or another platform.
- [Analytics](https://www.mintlify.com/docs/optimize/analytics.md): Track documentation analytics and understand content effectiveness with visitor data.
- [Feedback](https://www.mintlify.com/docs/optimize/feedback.md): Monitor user satisfaction and feedback on your documentation.
- [PDF exports](https://www.mintlify.com/docs/optimize/pdf-exports.md): Export your documentation as a single PDF file with a navigable table of contents for offline viewing.
- [SEO](https://www.mintlify.com/docs/optimize/seo.md): Optimize SEO with meta tag configuration for better search visibility.
- [Hidden pages](https://www.mintlify.com/docs/organize/hidden-pages.md): Hide pages from your navigation while keeping them accessible.
- [Exclude files from publishing](https://www.mintlify.com/docs/organize/mintignore.md): Exclude specific files and directories from your published documentation with a `.mintignore` file.
- [Navigation](https://www.mintlify.com/docs/organize/navigation.md): Design information architecture that aligns with user needs.
- [Pages](https://www.mintlify.com/docs/organize/pages.md): Configure page metadata, titles, and frontmatter properties.
- [Global settings](https://www.mintlify.com/docs/organize/settings.md): Configure site-wide settings in docs.json including theme, colors, navigation, API playground, and integrations.
- [Quickstart](https://www.mintlify.com/docs/quickstart.md): Deploy your documentation site and make your first change.
- [What is Mintlify?](https://www.mintlify.com/docs/what-is-mintlify.md): Mintlify is a knowledge platform for hosting information designed for people and AI.

## OpenAPI Specs

- [admin-openapi](https://www.mintlify.com/docs/admin-openapi.json)
- [discovery-openapi](https://www.mintlify.com/docs/discovery-openapi.json)
- [analytics.openapi](https://www.mintlify.com/docs/analytics.openapi.json)
- [openapi](https://www.mintlify.com/docs/openapi.json)

## AsyncAPI Specs

- [asyncapi](https://www.mintlify.com/docs/asyncapi.yaml)