Integrations

Typesense

Connect Typesense to search your collections, add and update documents, tune results with synonyms and curation, and manage your clusters.

API credentialsDeveloper & InfrastructureTypesense API docsTypesense MCP server overview

You paste two values into PopMCP: your Typesense server's address and an API key. On Typesense Cloud both come from the Generate API Keys button on your cluster's page. A Cluster Management API key is optional and adds clusters, backups, logs and billing.

Setup time
2 min
Auth
API credentials
API base URL
https://YOUR-HOST/
Rate limits
Typesense has no HTTP rate limits on its server API by default, though rate limit rules set on your own server can add them. The Typesense Cloud Cluster Management API allows 30 requests a minute per key.

Before you begin

  • A Typesense Cloud cluster, or a self-hosted Typesense server reachable from the internet over https. A server on plain http, on a private network or only on your own computer cannot be reached
  • On Typesense Cloud, access to the cluster. On a team account, your role has to allow managing keys
  • Optional: a Cluster Management API key, if you also want the AI to manage clusters, backups and billing

Get your credentials

Open your cluster on Typesense Cloud

Sign in at cloud.typesense.org and open the cluster you want to connect. If you run Typesense yourself, skip to the step about self-hosted servers.

Open this screen →

Press Generate API Keys

On the cluster's page, click Generate API Keys. It gives you the cluster's hostnames, an admin key and a search-only key. A cluster has to have finished starting up first. Use the admin key if the AI should read and change data, and the search-only key if it should only search. Copy the hostname too: it looks like abc123.a1.typesense.net. On a cluster with several nodes, use the one without a number after the id.

Open this screen →

cloud.typesense.org/clusters/abc123
Acme
Clusters / abc123

abc123

In service

Connect to this cluster
Hostname
abc123.a1.typesense.net
Admin key
cBKq****9Rprk
Search-only key
y7CF****Ki0kL
Generate API Keys
The admin key can do everything on this cluster, including deleting collections. Keep it private.

Self-hosted: find your address and key

Your address is where the server answers over https, with its port if that is not 443, such as https://search.example.com:8108. The admin key is the --api-key the server was started with. On a package install, it is in the config file at /etc/typesense/typesense-server.ini. Check that https://your-address/health opens in a browser and shows {"ok":true}.

Open this screen →

Optional: make a Cluster Management API key

Skip this unless the AI should manage clusters, backups, logs or billing. On Typesense Cloud open your Account page, scroll to the bottom and click Read More next to the question about programmatic access. Pick the key's capabilities, starting with clusters:read and metrics:read, and click New Cluster Management API Key. Copy it now, because it is shown only once.

Open this screen →

cloud.typesense.org/account/management-api-keys
Acme
Account / Cluster Management API Keys

Cluster Management API Keys

Choose what this key may do.

Capabilities
Clusters
clusters:read
Metrics
metrics:read
New Cluster Management API Key

A key's capabilities are chosen when it is made. To change them, make a new key.

Paste the values into PopMCP and connect

In PopMCP open Typesense, enter the server address and paste the API key. Add the management key under More options if you made one. If your key only reaches some collections, name one of them there too. Click Connect Typesense. PopMCP checks that the address is a Typesense server, then that the key works, and names the connection after your server.

Open this screen →

Connect in PopMCP

Open your workspace, choose Typesense in the marketplace, and fill in the connect dialog:

FieldWhat to enter
Server addresstextOn Typesense Cloud this is the hostname on your cluster's page. Self-hosted: your server's address, with its port if it is not 443.
API keysecretUse the admin key to read and change everything, or the search-only key to only search. Stored encrypted.Encrypted with AES-256-GCM on save and never shown again.
Cluster Management API keysecretOptional, Typesense Cloud only. Adds clusters, backups, logs and billing. From Account, Cluster Management API Keys.Encrypted with AES-256-GCM on save and never shown again.
A collection this key can searchtextOnly for a key limited to named collections, which cannot be checked without one.

PopMCP verifies the credential against Typesense immediately. On success the connection flips to Verified and its MCP tools are provisioned.

Verify it worked

PopMCP checks that your address answers as Typesense before it sends the key, then tries the key and marks the connection Verified under your server's address. It notes when the key can only search, when the server is older than version 30, and whether the management key was accepted.

Troubleshooting

"... does not answer like a Typesense server ..."

Why: The address is not your Typesense server, or something else answers there.

Fix: On Typesense Cloud, use the hostname from your cluster's page. On your own server, include the port, and check that `/health` shows `{"ok":true}`.

"We could not reach ... over HTTPS ..."

Why: The server is down, the port is wrong, or it only speaks plain http. Typesense serves plain http unless it is given a certificate.

Fix: Give the server a TLS certificate or put an https proxy in front of it, then connect that address. PopMCP does not send keys over plain http.

"... is not a public internet address ..."

Why: The address points at `localhost` or a private network, which PopMCP cannot reach.

Fix: Run Typesense somewhere public, such as Typesense Cloud, and connect that address.

"... refused the connection ..."

Why: An IP allowlist or a firewall in front of the cluster blocked the request.

Fix: Allow PopMCP through it, or remove the restriction, then connect again.

"Typesense ... did not accept this API key ..."

Why: The key is wrong or revoked, or it only reaches named collections, which cannot be checked without one of their names.

Fix: Copy the key again. For a key limited to named collections, enter one of them under **More options**.

"That is a Cluster Management API key ..."

Why: The management key was pasted in the API key field.

Fix: Paste a cluster's admin key in that field, from **Generate API Keys**, and put the management key under **More options**.

A tool answers 401 after connecting

Why: Typesense uses 401 both for a bad key and for a key that lacks the action. The message names the action the tool needs.

Fix: Reconnect with a key that has it, such as the admin key. If every tool fails this way, the key was revoked.

Synonym or curation tools answer 404

Why: Version 30 replaced per-collection synonyms and overrides with synonym sets and curation sets, so the tool may be for another version.

Fix: The message names the tool for the other kind. `typesense_overview` shows your server's version.

Reference

On this page