# TypesenseKit MCP server

> Enables AI agents to perform search, schema inspection, collection operations, and cluster administration on Typesense databases.

- Repository: https://github.com/akshitkrnagpal/typesensekit
- Page: https://hostedmcp.org/servers/akshitkrnagpal/typesensekit
- Transport: stdio
- Stars: 3
- License: MIT
- Latest version: 1.4.3

## Install

### Claude Code

```sh
claude mcp add --env 'TYPESENSE_API_KEY=<YOUR_TYPESENSE_API_KEY>' --env 'TYPESENSE_URL=<TYPESENSE_URL>' typesensekit -- npx -y @typesensekit/mcp
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "typesensekit": {
      "command": "npx",
      "args": [
        "-y",
        "@typesensekit/mcp"
      ],
      "env": {
        "TYPESENSE_API_KEY": "<YOUR_TYPESENSE_API_KEY>",
        "TYPESENSE_URL": "<TYPESENSE_URL>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "typesensekit": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@typesensekit/mcp"
      ],
      "env": {
        "TYPESENSE_API_KEY": "<YOUR_TYPESENSE_API_KEY>",
        "TYPESENSE_URL": "<TYPESENSE_URL>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"typesensekit","type":"stdio","command":"npx","args":["-y","@typesensekit/mcp"],"env":{"TYPESENSE_API_KEY":"<YOUR_TYPESENSE_API_KEY>","TYPESENSE_URL":"<TYPESENSE_URL>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "typesensekit": {
      "command": "npx",
      "args": [
        "-y",
        "@typesensekit/mcp"
      ],
      "env": {
        "TYPESENSE_API_KEY": "<YOUR_TYPESENSE_API_KEY>",
        "TYPESENSE_URL": "<TYPESENSE_URL>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add typesensekit --env 'TYPESENSE_API_KEY=<YOUR_TYPESENSE_API_KEY>' --env 'TYPESENSE_URL=<TYPESENSE_URL>' -- npx -y @typesensekit/mcp
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.typesensekit]
command = "npx"
args = ["-y", "@typesensekit/mcp"]

[mcp_servers.typesensekit.env]
TYPESENSE_API_KEY = "<YOUR_TYPESENSE_API_KEY>"
TYPESENSE_URL = "<TYPESENSE_URL>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'TYPESENSE_API_KEY=<YOUR_TYPESENSE_API_KEY>' -e 'TYPESENSE_URL=<TYPESENSE_URL>' typesensekit npx -- -y @typesensekit/mcp
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "typesensekit": {
      "command": "npx",
      "args": [
        "-y",
        "@typesensekit/mcp"
      ],
      "env": {
        "TYPESENSE_API_KEY": "<YOUR_TYPESENSE_API_KEY>",
        "TYPESENSE_URL": "<TYPESENSE_URL>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `TYPESENSE_API_KEY` | yes | yes | Typesense API key used to authenticate server operations. |
| `TYPESENSE_URL` | yes | no | URL of the Typesense server, including protocol and port when required. |
| `TYPESENSEKIT_READ_ONLY` | no | no | Expose only read operations unless explicitly disabled. |
| `TYPESENSE_CONNECTION_TIMEOUT_SECONDS` | no | no | Optional Typesense connection timeout in seconds. |

## FAQ

### Is the server read-only by default?

Yes, the server runs in read-only mode by default to ensure safety.

### How can I enable write and delete operations?

You can expose write, delete, and admin tools by setting the environment variable TYPESENSEKIT_READ_ONLY to false.

### How can I reduce the context size for smaller agent contexts?

Use the collections.list tool with the compact parameter set to true to receive a condensed version of the collection data.
