Agenten stärken
Installation vom Herausgeber. Kein PlugMCP-Endpunkt.
Host a copy with our keys and logs.
Noch kein paketiertes Release in der Registry. Folgen Sie der README des Repositorys.
Remote-URL oder ein Befehl auf Ihrem Rechner? Worin sich die beiden Installationen unterscheiden
Auf PlugMCP ausführen
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
StartenVom Herausgeber
Open-source Ask AI for your docs. Cited answers on your own model key, and an MCP server for coding agents, from one index built with your Starlight, Docusaurus or VitePress site. No vendor, no vector database.
For teams that run their own developer docs, at product, API and platform companies, who want Ask AI without a hosted assistant.
Open-source Ask AI for your docs, with an MCP server for agents: cited answers on your own model key, from one static index built with your site. No vendor, no vector database. Starlight, Docusaurus and VitePress plugins, Next.js, or one script tag.
Website: ondocs.vercel.app, whose docs answer with OpenAI and serve agents at /api/mcp. Formerly ask-my-site (what changed).
Feedback wanted: say where it breaks in the launch feedback thread, see what's next in the roadmap, or pick up a good first issue. If ondocs is useful to you, a star helps other people find it.
The live demo: a streamed answer with citations, one opening the section it came from, then the one-line setups.
Live demos: Starlight, Docusaurus and VitePress, each a real docs site built with its plugin.
One index, ask-index.json, built with your site, feeds three things:
search, fetch and list_pages over the same index, for coding agents and ChatGPT. Agents bring their own model, and keyword search, the default, calls no model at all.llms.txt, llms-full.txt and a .md copy of every page, written with the build.Search runs in memory inside one function you deploy: BM25 and vectors, merged with reciprocal rank fusion.
Each answers from an endpoint you deploy as one function next to the site, rate-limited by default. npx ondocs init writes it for Vercel, Netlify, Cloudflare or GitHub Pages (as a Worker answering with Workers AI, no API key): see Deploying.
Starlight. npm i ondocs ai @ai-sdk/openai, then:
// astro.config.mjs
import starlight from '@astrojs/starlight';
import ondocs from 'ondocs/starlight';
import { defineConfig } from 'astro/config';
export default defineConfig({
integrations: [starlight({ title: 'Acme Docs', plugins: [ondocs()] })],
});
After astro build, it indexes the pages into dist/ask-index.json, writes llms.txt and the .md pages, and adds an "Ask AI" button with ⌘I. Static site? npx ondocs init. SSR adapter? Nothing to do.
Docusaurus. npm i ondocs ai @ai-sdk/openai @radix-ui/react-dialog cmdk, then:
// docusaurus.config.ts
export default { plugins: ['ondocs/docusaurus'] };
It does the same after docusaurus build, into build/.
Next.js. With OPENAI_API_KEY set, index your content with npx ondocs index ./content --base-url /docs --llms-txt public, then:
// app/api/ask/route.ts
import { openai } from '@ai-sdk/openai';
import { createAskHandler } from 'ondocs/server';
import index from '../../../ask-index.json';
export const POST = createAskHandler({
index,
model: openai('gpt-5.4-mini'),
embeddingModel: openai.embedding('text-embedding-3-small'),
});
and render the dialog in your layout, with its two stylesheets:
// app/layout.tsx
import { AskDialog } from 'ondocs/react';
import 'ondocs/react/styles.css';
import 'ondocs/embed/launcher.css';
// …then <AskDialog launcher /> in the body
Any other site. Index the HTML it builds, write the endpoint with npx ondocs init, and add the script tag:
npx ondocs index public -o public/ask-index.json # embeds with OPENAI_API_KEY, best for the Ask box; -e none for keyword-only
npx ondocs init --out public # plain HTML needs --out; Hugo, Jekyll, MkDocs and Eleventy are detected
# For the Workers AI Worker (init --host github-pages), index with -e workers-ai:@cf/baai/bge-small-en-v1.5
# and CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN set, or -e none: it can't embed questions for an OpenAI index
On a GitHub Pages project site, at https://user.github.io/repo, add --base-url /repo to the index command.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/embed.global.js" defer></script>
Try it without a key. npx ondocs index ./docs -e mock, then npx ondocs dev, serves the ask endpoint and MCP server on localhost, with a mock model that quotes your docs. See Try it locally.
The same index, served to agents with createMcpHandler:
// app/api/mcp/route.ts
import { createMcpHandler } from 'ondocs/server';
import index from '../../../ask-index.json';
const handler = createMcpHandler({ index, siteName: 'the Acme docs' });
export { handler as POST, handler as GET, handler as DELETE, handler as OPTIONS };
claude mcp add --transport http acme-docs https://docs.acme.dev/api/mcp # Claude Code
codex mcp add acme-docs --url https://docs.acme.dev/api/mcp # Codex
gemini mcp add --transport http --scope user acme-docs https://docs.acme.dev/api/mcp # Gemini CLI
initialize, tested with the official TypeScript client.search returns ranked sections with a snippet and an anchor URL, and fetch a page or section as Markdown, as ChatGPT's connectors expect.mcp option, a page can show an "Add to Cursor / VS Code / Claude" block.--llms-txt <dir>.See MCP server and llms.txt and Markdown pages.
embeddingModel.budget caps questions and model tokens per UTC day for the whole endpoint, answerCache answers repeated questions without a model call, and challenge adds an optional Turnstile bot check.ondocs eval, readers' ratings and a log of unanswered questions to wire yourself.onToolCall shows what agents search for.What ondocs adds: open source you host. The index is a file in your build, the endpoint a function on your host, the model key yours, with no vendor account. See Limits and trade-offs for where it is the wrong tool.
Requires Node.js 22.12 or later and AI SDK 7 (ai@^7.0.95); AI SDK 6 is not supported. MIT © Diogo Esteves
Open-source Ask AI for your docs, with an MCP server for agents: cited answers on your own model key, from one static index built with your site. No vendor, no vector database. Starlight, Docusaurus a
Übersicht
Open-source Ask AI for your docs, with an MCP server for agents: cited answers on your own model key, from one static index built with your site. No vendor, no vector database. Starlight, Docusaurus and VitePress plugins, Next.js, or one script tag.
Tools
Noch keine Tool-Liste. Remote-Server erhalten eine nach dem ersten Health-Check.
FAQ
Kopieren Sie auf dieser Seite die stdio-Konfiguration für Cursor, Claude Desktop, Claude Code oder VS Code. Sie nutzt die Installation des Herausgebers, keinen PlugMCP-Proxy.
In diesem Eintrag ist keine erforderliche Umgebungsvariable aufgeführt.
Ondocs läuft lokal über stdio.
Zuletzt geprüft: 2026-10-28. Open-source Ask AI for your docs, with an MCP server for agents: cited answers on your own model key, from one static index built with your site. No vendor, no vector database. Starlight, Docusaurus and VitePress plugins, Next.js, or one script tag.
