Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .cursor/mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"mcpServers": {
"algolia-docsearch": {
"type": "http",
"url": "https://mcp.algolia.com/1/docsearch/mcp"
}
}
}
1 change: 1 addition & 0 deletions .cursor/rules/use-algolia-docsearch.mdc
1 change: 1 addition & 0 deletions .cursor/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
4 changes: 2 additions & 2 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
bun 1.3.10
node 22.15.0
bun 1.3.10
nodejs latest
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ export default App;

[Read documentation →](https://docsearch.algolia.com/docs/styling)

## MCP plugins

Client plugins for the public DocSearch MCP endpoint are in [`mcp/plugins/docsearch`](mcp/plugins/docsearch). They connect Cursor and Claude Code to `https://mcp.algolia.com/1/docsearch/mcp` for current public developer documentation.

## Related projects

DocSearch is made of the following repositories:
Expand Down
9 changes: 9 additions & 0 deletions mcp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# DocSearch MCP

Client plugin packages for the public Algolia DocSearch MCP endpoint live in [`plugins/docsearch`](plugins/docsearch).

```text
https://mcp.algolia.com/1/docsearch/mcp
```

The plugins connect AI coding clients to the public DocSearch documentation corpus. They do not expose crawler operations, DocSearch administration, private documentation, or Algolia index credentials.
71 changes: 71 additions & 0 deletions mcp/plugins/docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Algolia DocSearch MCP Plugins

This directory contains client plugin packages for the public Algolia DocSearch MCP endpoint:

```text
https://mcp.algolia.com/1/docsearch/mcp
```

The plugins connect AI coding clients to the public DocSearch documentation corpus. They do not expose crawler operations, DocSearch administration, private documentation, or Algolia index credentials.

## Packages

- `mcp/plugins/docsearch/cursor/algolia-docsearch` - Cursor plugin package with MCP config, rule, skill, and README.
- `mcp/plugins/docsearch/claude/algolia-docsearch` - Claude Code plugin package with MCP config, skill, command, and README.

## Public MCP Tools

You can query in natural language — full sentences and questions work well.

### algolia_docsearch_search_docs

One-shot lookup, and the right default for most questions. Pass a `library` and a `query`; it resolves the best matching documentation set and returns ranked content in a single call:

```json
{
"library": "Next.js",
"query": "how do middleware matchers work"
}
```

If the library is ambiguous, it returns candidate documentation sets instead — pick a `docset_id` and pass it to `algolia_docsearch_query_docs`.

### algolia_docsearch_resolve_docset

Step 1 of the manual flow. Finds matching documentation sets and returns candidates with:

- `docset_id`
- title and description
- optional quality signals such as `trustScore`, `benchmarkScore`, and `popularityScore`

```json
{
"query": "Next.js app router"
}
```

### algolia_docsearch_query_docs

Step 2 of the manual flow. Queries documentation content for the selected `docset_id` values. Pass several when a question spans multiple products:

```json
{
"query": "middleware matcher config",
"docsetIds": ["nextjs"]
}
```

## Claude Desktop And claude.ai

Claude Desktop and claude.ai can connect directly to the same remote MCP endpoint when remote connectors are available in the client:

```json
{
"algolia-docsearch": {
"type": "http",
"url": "https://mcp.algolia.com/1/docsearch/mcp"
}
}
```

No user authentication is required for the public DocSearch MCP endpoint.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "algolia-docsearch-marketplace",
"description": "Algolia DocSearch plugins for Claude Code — search up-to-date public developer documentation from the DocSearch corpus.",
"owner": {
"name": "Algolia"
},
"plugins": [
{
"name": "algolia-docsearch",
"source": ".",
"description": "up-to-date public developer documentation from the DocSearch corpus.",
"version": "1.0.0"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "algolia-docsearch",
"description": "Algolia DocSearch MCP plugin for searching up-to-date public developer documentation from the DocSearch corpus.",
"version": "1.0.0",
"author": {
"name": "Algolia"
}
}
6 changes: 6 additions & 0 deletions mcp/plugins/docsearch/claude/algolia-docsearch/.mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"algolia-docsearch": {
"type": "http",
"url": "https://mcp.algolia.com/1/docsearch/mcp"
}
}
63 changes: 63 additions & 0 deletions mcp/plugins/docsearch/claude/algolia-docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Algolia DocSearch Plugin for Claude Code

Algolia DocSearch connects Claude Code to the public DocSearch MCP endpoint for current public developer documentation.

## What's Included

- **MCP Server** - Connects Claude Code to `https://mcp.algolia.com/1/docsearch/mcp`.
- **Skill** - Auto-triggers documentation lookups for public developer docs questions.
- **Command** - `/algolia-docsearch:docs` for manual documentation queries.

The plugin teaches the one-shot `search_docs` lookup and the `resolve_docset` + `query_docs` flow.

## Installation

For local beta testing, install this plugin package from:

```text
mcp/plugins/docsearch/claude/algolia-docsearch
```

The MCP server config is also available at:

```text
mcp/plugins/docsearch/claude/algolia-docsearch/.mcp.json
```

For Claude Code marketplace install from this repository:

```text
/plugin marketplace add algolia/docsearch
/plugin install algolia-docsearch@algolia-docsearch-marketplace
```

## Available Tools

### algolia_docsearch_search_docs

One-shot lookup, and the right default for most questions. Pass a `library` (product or platform) and a `query` (the question); it resolves the best documentation set and returns ranked content in a single call.

### algolia_docsearch_resolve_docset

Step 1 of the manual flow. Finds matching documentation sets and returns candidates with a `docset_id`, title, description, and ranking signals.

### algolia_docsearch_query_docs

Step 2 of the manual flow. Queries documentation content for the `docset_id` values returned by `algolia_docsearch_resolve_docset`. Pass several `docsetIds` when a question spans multiple products.

## Usage Examples

Ask Claude questions like:

- "How do I configure middleware in Next.js?"
- "Show me Stripe webhook signature verification from the docs."
- "What is the current Algolia InstantSearch React setup?"

Or use the manual command:

```text
/algolia-docsearch:docs Next.js middleware matcher
/algolia-docsearch:docs Stripe webhook signature verification
```

The plugin is for public developer documentation only. It does not expose crawler operations, DocSearch administration, private docs, or Algolia index credentials.
31 changes: 31 additions & 0 deletions mcp/plugins/docsearch/claude/algolia-docsearch/commands/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
description: Look up public developer documentation with Algolia DocSearch
argument-hint: [query]
---

# /algolia-docsearch:docs

Fetch current public developer documentation from the Algolia DocSearch MCP corpus.

## Usage

```text
/algolia-docsearch:docs <library-or-product> [topic]
```

For most lookups, call `algolia_docsearch_search_docs` in a single step:

1. Set `library` to the product, library, or platform (use the official name).
2. Set `query` to the topic or question, in natural language.
3. Answer using the returned docs and include source URLs when available.

If the library is ambiguous, `algolia_docsearch_search_docs` returns candidate documentation sets — pick the right `docset_id` and pass it to `algolia_docsearch_query_docs`. Use the `algolia_docsearch_resolve_docset` + `algolia_docsearch_query_docs` flow when a question spans several products.

## Examples

```text
/algolia-docsearch:docs Next.js middleware matcher
/algolia-docsearch:docs Stripe webhook signature verification
/algolia-docsearch:docs Algolia InstantSearch React configure search client
/algolia-docsearch:docs React Server Components data fetching
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: algolia-docsearch-mcp
description: Use this skill when the user asks about public developer documentation, SDKs, APIs, libraries, frameworks, setup, configuration, or code examples. Fetch current docs from Algolia DocSearch MCP and cite source URLs.
---

When the user asks about public developer documentation, use Algolia DocSearch MCP instead of relying only on training data.

## When To Use

Use this skill when the user:

- Asks setup or configuration questions for a public library, framework, SDK, API, or developer tool.
- Requests code examples that should match current docs.
- Needs API reference details, migration guidance, or command syntax.
- Mentions a library or framework whose docs may have changed recently.
- Asks for sources or citations from public documentation.

Do not use this skill for private company docs, internal repositories, unpublished APIs, or questions where the user already supplied the relevant docs.

## Tools

DocSearch MCP exposes three tools. You can query in natural language — full sentences and questions work well.

- `algolia_docsearch_search_docs` — one-shot lookup. Use this by default.
- `algolia_docsearch_resolve_docset` — step 1 of the manual flow: find documentation sets.
- `algolia_docsearch_query_docs` — step 2 of the manual flow: fetch content for chosen docsets.

## Default Flow: One-Shot Search

Call `algolia_docsearch_search_docs` for most lookups.

Input:

- `library`: the product, library, SDK, or platform. Use the official name (for example: `Next.js`, `Stripe`, `Algolia InstantSearch`).
- `query`: the question, in natural language (for example: `how do middleware matchers work`).

It resolves the best matching documentation set and returns ranked content in a single call. If `library` is ambiguous, it returns candidate documentation sets instead — pick the right one and pass its `docset_id` to `algolia_docsearch_query_docs`, or retry with the official product name.

## Manual Flow: Resolve, Then Query

Use the two-step flow when a question spans several products, or when you want to inspect and hand-pick documentation sets.

### Step 1: Resolve The Docset

Call `algolia_docsearch_resolve_docset`.

Input:

- `query`: describe the product, library, SDK, or platform. Including the vendor name improves matching.
- `topN`: optional. Use the default unless the initial result is ambiguous.

Each candidate returns a `title`, `docset_id`, `description`, and ranking signals (`trustScore`, `benchmarkScore`, `popularityScore`). Prefer the official vendor's docset over third-party mentions, breaking ties by the higher scores.

### Step 2: Query The Docs

Call `algolia_docsearch_query_docs`.

Input:

- `query`: what to find in the docs, in natural language.
- `docsetIds`: an array of the `docset_id` values you selected. Pass several when a question spans multiple products.

## Answer With Sources

Use the returned documentation content to answer the user directly.

Guidelines:

- Include source URLs from the tool result when available.
- Say when DocSearch does not return a relevant result.
- Do not invent source citations.
- Keep the answer focused on the user's question.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "algolia-docsearch",
"version": "1.0.0",
"description": "Algolia DocSearch MCP plugin for searching up-to-date public developer documentation from the DocSearch corpus.",
"author": {
"name": "Algolia"
},
"homepage": "https://docsearch.algolia.com/docs/mcp/overview",
"keywords": ["documentation", "mcp", "algolia", "docsearch", "developer-docs"],
"logo": "assets/docsearch-monogram.svg"
}
47 changes: 47 additions & 0 deletions mcp/plugins/docsearch/cursor/algolia-docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Algolia DocSearch Plugin for Cursor

Algolia DocSearch connects Cursor to the public DocSearch MCP endpoint for current public developer documentation.

## What's Included

- **MCP Server** - Connects Cursor to `https://mcp.algolia.com/1/docsearch/mcp`.
- **Rule** - Nudges the agent to use DocSearch for public developer docs instead of guessing from training data.
- **Skill** - Documents the one-shot `search_docs` lookup and the `resolve_docset` + `query_docs` flow.

## Installation

For local beta testing, install this plugin package from:

```text
mcp/plugins/docsearch/cursor/algolia-docsearch
```

The MCP server config is also available at:

```text
mcp/plugins/docsearch/cursor/algolia-docsearch/mcp.json
```

## Available Tools

### algolia_docsearch_search_docs

One-shot lookup, and the right default for most questions. Pass a `library` (product or platform) and a `query` (the question); it resolves the best documentation set and returns ranked content in a single call.

### algolia_docsearch_resolve_docset

Step 1 of the manual flow. Finds matching documentation sets and returns candidates with a `docset_id`, title, description, and ranking signals.

### algolia_docsearch_query_docs

Step 2 of the manual flow. Queries documentation content for the `docset_id` values returned by `algolia_docsearch_resolve_docset`. Pass several `docsetIds` when a question spans multiple products.

## Usage Examples

Ask Cursor questions like:

- "How do I configure middleware in Next.js?"
- "Show me Stripe webhook signature verification from the docs."
- "What is the current Algolia InstantSearch React setup?"

The plugin is for public developer documentation only. It does not expose crawler operations, DocSearch administration, private docs, or Algolia index credentials.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions mcp/plugins/docsearch/cursor/algolia-docsearch/mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"mcpServers": {
"algolia-docsearch": {
"type": "http",
"url": "https://mcp.algolia.com/1/docsearch/mcp"
}
}
}
Loading