Skip to content

Integrations

Keep your search client and your site. DocSlurp replaces the index behind them.

Find the way to connect DocSlurp to your app, site or agent, and see what ships today and what's planned. Start with a native interface, or use an adapter to keep a search UI you already have. To see search working first, try the live playground.

On this page

Native interfaces

Upload documents, wait for processing and retrieve cited passages. Every interface reads and writes the same workspaces, so you can mix them: upload from the CLI, search from your app.

  • HTTP API

    Upload, process and retrieve from any language. Start here when you want direct control.

    /openapi.jsonAvailable
  • JavaScript / TypeScript

    Typed ingestion, cited search and run progress for Node.js applications.

    @docslurp/sdkAvailable
  • MCP server

    Let agents and coding tools search your workspaces and cite the page.

    /v1/mcpAvailable
  • Command line

    Upload files, watch processing and retrieve evidence from your terminal or CI.

    @docslurp/cliAvailable
  • OpenAI-compatible chat

    Point any OpenAI SDK at a workspace and get cited answers, with streaming and usage.

    /v1/chat/completionsAvailable

Integration subpaths and live progress methods require SDK and CLI v0.2.0 or newer. Check availability.

Search adapters

Already calling Algolia, Pagefind, Meilisearch or Typesense? Replace the client constructor and keep your search calls and result rendering. DocSlurp handles ingestion and retrieval, and every hit carries its source page.

search.tsAlgolia
- const client = algoliasearch(appId, apiKey)
+ const client = createDocSlurpAlgoliaClient({ apiUrl, clientKey })
  await client.search({ requests })  // unchanged

Adapters cover a documented subset of each API. Filters, provider administration and the stock Pagefind UI need a compatibility review; each guide lists what is supported.

Websites and CMS

Put cited search on a site you already run. Astro and WordPress have packages; Next.js and plain HTML use the framework-free widget. Dedicated CMS connectors are planned, and the HTTP API and widget work with any of them today.

Frameworks and plugins

CMS platforms

Documentation sites

CMS priorities combine CMS adoption data with a headless target; this is a delivery roadmap, not a market-share ranking. Each connector must handle published content, updates, deletes and private-content permissions.

Other languages

JavaScript and TypeScript have a native SDK today. For any other language, call the HTTP API; it is plain JSON over HTTPS. The native clients below are planned and not published, so don't install a package by guessing its name.

LanguageRegistryStatusLinks
JavaScript / TypeScriptnpmAvailable@docslurp/sdk
PythonPyPIPlannedSDK planPyPI signup
Rustcrates.ioPlannedSDK planGitHub signup
Go / GolangGo modulesPlannedSDK planGitHub signup
ElixirHexPlannedSDK planHex signup
.NET / C#NuGetPlannedSDK planMicrosoft signup
Java / Kotlin (JDK)Maven CentralPlannedSDK planCentral account setup
SmalltalkMetacello / sourcePlannedSDK planGitHub signup
Modern C++CMake with Conan or vcpkgPlannedSDK planGitHub signup
PHPPackagistPlannedSDK planPackagist signup
RubyRubyGemsPlannedSDK planRubyGems signup

Registry links are for maintainers publishing a client; you don't need an account to call the API. crates.io uses GitHub login, NuGet uses Microsoft sign-in, and Go modules, Smalltalk and Conan or vcpkg recipes publish from source hosting. Java is shown with the OpenJDK mark; Oracle's Java logo is a separate trademark. Publishing notes.

Hand off to an agent

Each prompt tells a coding agent which guide to read, which contracts to keep and what to verify. Copy one into Claude Code, Codex or Cursor from the root of your project. Prompts use placeholders and never contain keys.

  • HTTP API
    Review agent instructions
  • JavaScript / TypeScript
    Review agent instructions
  • MCP server
    Review agent instructions
  • Command line
    Review agent instructions
  • OpenAI-compatible chat
    Review agent instructions
  • Algolia
    Review agent instructions
  • Pagefind
    Review agent instructions
  • Meilisearch
    Review agent instructions
  • Typesense
    Review agent instructions
  • Astro
    Review agent instructions
  • WordPress
    Review agent instructions
  • Next.js
    Review agent instructions
  • HTML / other CMS
    Review agent instructions
  • Shopify
    Review agent instructions
  • Wix
    Review agent instructions
  • Squarespace
    Review agent instructions
  • Joomla
    Review agent instructions
  • Webflow
    Review agent instructions
  • Drupal
    Review agent instructions
  • Strapi
    Review agent instructions
  • Docusaurus
    Review agent instructions
  • Slate
    Review agent instructions

Jump to