Skip to content
Open
Show file tree
Hide file tree
Changes from 4 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
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.
66 changes: 66 additions & 0 deletions mcp/plugins/docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# 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

### algolia_docsearch_resolve_docset

Finds matching documentation sets and returns candidates with:

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

Use concise keyword-only queries, for example:

```text
Next.js middleware
Stripe webhooks
Algolia InstantSearch React
```

### algolia_docsearch_query_docs

Queries documentation content for selected docsets.

Use the selected `docset_id` values as `docsetIds`. Pass each selected `targetIndex` as `indexName` in the `targets` array:

```json
{
"query": "middleware matcher config",
"docsetIds": ["nextjs"],
"targets": [
{
"docsetId": "nextjs",
"indexName": "nextjs_docs"
}
]
}
```

## 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,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"
}
}
67 changes: 67 additions & 0 deletions mcp/plugins/docsearch/claude/algolia-docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 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.

## 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_resolve_docset

Finds matching documentation sets and returns `docset_id` plus `targetIndex` values.

Use keyword-only queries:

```text
Next.js middleware
Stripe webhooks
Algolia InstantSearch React
```

### algolia_docsearch_query_docs

Queries documentation content for selected docsets.

Use the `docset_id` values returned by `algolia_docsearch_resolve_docset`, and pass each selected `targetIndex` as the `indexName` in `targets`.

## 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.
32 changes: 32 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,32 @@
---
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]
```

The command should use the DocSearch two-step flow:

1. Call `algolia_docsearch_resolve_docset` with a concise keyword query for the library, product, API, or framework.
2. Pick the best matching `docset_id` and `targetIndex`.
3. Call `algolia_docsearch_query_docs` with a concise keyword query, `docsetIds`, and `targets`.
4. Answer using the returned docs and include source URLs when available.

## 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
```

Use keyword-only tool queries. Do not pass full sentences or conversational phrasing to the MCP tools.
14 changes: 14 additions & 0 deletions mcp/plugins/docsearch/claude/algolia-docsearch/marketplace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "algolia-docsearch-marketplace",
"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,88 @@
---
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.

## Tool Flow

### Step 1: Resolve The Docset

Call `algolia_docsearch_resolve_docset` first.

Use a concise keyword-only query, not the user's full sentence. Good examples:

- `Next.js middleware`
- `React Server Components`
- `Stripe webhooks`
- `Algolia InstantSearch React`

Input:

- `query`: concise keywords for the library, product, API, or concept.
- `topN`: optional. Use the default unless the initial result is ambiguous.

### Step 2: Select The Best Candidate

Choose the candidate that best matches the user's target docs.

Prefer:

- Exact product, library, or framework name matches.
- Official or primary documentation when the title/description makes that clear.
- Higher `trustScore`, `benchmarkScore`, or `popularityScore` when multiple candidates look similar.

Keep the selected candidate's:

- `docset_id`
- `targetIndex`

Convert that pair into a `targets` entry for the next tool:

```json
{
"docsetId": "<docset_id>",
"indexName": "<targetIndex>"
}
```

### Step 3: Query The Docs

Call `algolia_docsearch_query_docs`.

Use a concise keyword-only query for the specific documentation content. Good examples:

- `middleware matcher config`
- `server components data fetching`
- `webhook signature verification`
- `configure search client`

Input:

- `query`: concise keywords for the docs content.
- `docsetIds`: an array containing the selected `docset_id` values.
- `targets`: an array of `{ "docsetId": "...", "indexName": "..." }` entries built from the selected candidates.

### Step 4: 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,12 @@
{
"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",
"url": "https://www.algolia.com"
},
"keywords": ["documentation", "mcp", "algolia", "docsearch", "developer-docs"],
"logo": "https://www.algolia.com/favicon.ico",
"primaryColor": "#003DFF"
}
53 changes: 53 additions & 0 deletions mcp/plugins/docsearch/cursor/algolia-docsearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 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 two-step `resolve_docset` then `query_docs` lookup 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_resolve_docset

Finds matching documentation sets and returns `docset_id` plus `targetIndex` values.

Use keyword-only queries:

```text
Next.js middleware
Stripe webhooks
Algolia InstantSearch React
```

### algolia_docsearch_query_docs

Queries documentation content for selected docsets.

Use the `docset_id` values returned by `algolia_docsearch_resolve_docset`, and pass each selected `targetIndex` as the `indexName` in `targets`.

## 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.
5 changes: 5 additions & 0 deletions mcp/plugins/docsearch/cursor/algolia-docsearch/mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"algolia-docsearch": {
"url": "https://mcp.algolia.com/1/docsearch/mcp"
}
}
Loading