Can I use Typesense as a CLI?

Yes. KosmoKrator exposes a Typesense CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Typesense through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Typesense tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Typesense credentials stored?

Typesense credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Typesense MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Typesense MCP, CLI, and Lua Integration for AI Agents

Typesense integration docs for AI agents: MCP gateway setup, Typesense CLI commands, Lua API reference, credentials, and function schemas.

Typesense for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

Typesense CLIHeadless setup, JSON output, direct function calls. Typesense MCPExpose selected tools to local MCP clients. Typesense LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug: typesense
route_slug: typesense
package: typesense
auth_strategy: api_key
cli_setup_supported: true
cli_runtime_supported: true
mcp_gateway_supported: true
lua_supported: true

Function Catalog

Function	Type	Description
`typesense.typesense_clear_cache`	Write `write`	Clear the cached responses of search requests in the LRU cache. Clear the cached responses of search requests that are sent with `use_cache` parameter in the LRU cache.
`typesense.typesense_compact_db`	Write `write`	Compacting the on-disk database Typesense uses RocksDB to store your documents on the disk. If you do frequent writes or updates, you could benefit from running a compaction of the underlying RocksDB database. This could reduce the size of the database and decrease read latency. While the database will not block during this operation, we recommend running it during off-peak hours.
`typesense.typesense_create_analytics_event`	Write `write`	Create an analytics event Submit a single analytics event. The event must correspond to an existing analytics rule by name.
`typesense.typesense_create_analytics_rule`	Write `write`	Create analytics rule(s) Create one or more analytics rules. You can send a single rule object or an array of rule objects.
`typesense.typesense_create_collection`	Write `write`	Create a new collection When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.
`typesense.typesense_create_conversation_model`	Write `write`	Create a conversation model Create a Conversation Model
`typesense.typesense_create_key`	Write `write`	Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place.
`typesense.typesense_create_n_l_search_model`	Write `write`	Create a NL search model Create a new NL search model.
`typesense.typesense_debug`	Read `read`	Print debugging information
`typesense.typesense_delete_alias`	Write `write`	Delete an alias
`typesense.typesense_delete_analytics_rule`	Write `write`	Delete an analytics rule Permanently deletes an analytics rule, given it's name
`typesense.typesense_delete_collection`	Write `write`	Delete a collection Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.
`typesense.typesense_delete_conversation_model`	Write `write`	Delete a conversation model
`typesense.typesense_delete_curation_set`	Write `write`	Delete a curation set Delete a specific curation set by its name
`typesense.typesense_delete_curation_set_item`	Write `write`	Delete a curation set item Delete a specific curation item by its id
`typesense.typesense_delete_document`	Write `write`	Delete a document Delete an individual document from a collection by using its ID.
`typesense.typesense_delete_documents`	Write `write`	Delete a bunch of documents that match a specific filter condition. Use the `batch_size` parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.
`typesense.typesense_delete_key`	Write `write`	Delete an API key given its ID.
`typesense.typesense_delete_n_l_search_model`	Write `write`	Delete a NL search model Delete a specific NL search model by its ID.
`typesense.typesense_delete_preset`	Write `write`	Delete a preset. Permanently deletes a preset, given it's name.
`typesense.typesense_delete_stopwords_set`	Write `write`	Delete a stopwords set. Permanently deletes a stopwords set, given it's name.
`typesense.typesense_delete_synonym_set`	Write `write`	Delete a synonym set Delete a specific synonym set by its name
`typesense.typesense_delete_synonym_set_item`	Write `write`	Delete a synonym set item Delete a specific synonym item by its id
`typesense.typesense_export_documents`	Read `read`	Export all documents in a collection in JSON lines format.
`typesense.typesense_flush_analytics`	Write `write`	Flush in-memory analytics to disk Triggers a flush of analytics data to persistent storage.
`typesense.typesense_get_alias`	Read `read`	Retrieve an alias Find out which collection an alias points to by fetching it
`typesense.typesense_get_aliases`	Read `read`	List all aliases and the corresponding collections that they map to.
`typesense.typesense_get_analytics_events`	Read `read`	Retrieve analytics events Retrieve the most recent events for a user and rule.
`typesense.typesense_get_analytics_status`	Read `read`	Get analytics subsystem status Returns sizes of internal analytics buffers and queues.
`typesense.typesense_get_collection`	Read `read`	Retrieve a single collection Retrieve the details of a collection, given its name.
`typesense.typesense_get_document`	Read `read`	Retrieve a document Fetch an individual document from a collection by using its ID.
`typesense.typesense_get_health`	Read `read`	Checks if Typesense server is ready to accept requests.
`typesense.typesense_get_key`	Read `read`	Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key.
`typesense.typesense_get_keys`	Read `read`	Retrieve (metadata about) all keys.
`typesense.typesense_get_schema_changes`	Read `read`	Get the status of in-progress schema change operations Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response.
`typesense.typesense_get_stemming_dictionary`	Read `read`	Retrieve a stemming dictionary Fetch details of a specific stemming dictionary.
`typesense.typesense_import_documents`	Write `write`	Import documents into a collection The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.
`typesense.typesense_import_stemming_dictionary`	Write `write`	Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary.
`typesense.typesense_index_document`	Write `write`	Index a document A document to be indexed in a given collection must conform to the schema of the collection.
`typesense.typesense_list_collections`	Read `read`	List all collections Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
`typesense.typesense_list_stemming_dictionaries`	Read `read`	List all stemming dictionaries Retrieve a list of all available stemming dictionaries.
`typesense.typesense_multi_search`	Write `write`	send multiple search requests in a single HTTP request This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.
`typesense.typesense_retrieve_a_p_i_stats`	Read `read`	Get stats about API endpoints. Retrieve the stats about API endpoints.
`typesense.typesense_retrieve_all_conversation_models`	Read `read`	List all conversation models Retrieve all conversation models
`typesense.typesense_retrieve_all_n_l_search_models`	Read `read`	List all NL search models Retrieve all NL search models.
`typesense.typesense_retrieve_all_presets`	Read `read`	Retrieves all presets. Retrieve the details of all presets
`typesense.typesense_retrieve_analytics_rule`	Read `read`	Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name
`typesense.typesense_retrieve_analytics_rules`	Read `read`	Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results.
`typesense.typesense_retrieve_conversation_model`	Read `read`	Retrieve a conversation model
`typesense.typesense_retrieve_curation_set`	Read `read`	Retrieve a curation set Retrieve a specific curation set by its name
`typesense.typesense_retrieve_curation_set_item`	Read `read`	Retrieve a curation set item Retrieve a specific curation item by its id
`typesense.typesense_retrieve_curation_set_items`	Read `read`	List items in a curation set Retrieve all curation items in a set
`typesense.typesense_retrieve_curation_sets`	Read `read`	List all curation sets Retrieve all curation sets
`typesense.typesense_retrieve_metrics`	Read `read`	Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics.
`typesense.typesense_retrieve_n_l_search_model`	Read `read`	Retrieve a NL search model Retrieve a specific NL search model by its ID.
`typesense.typesense_retrieve_preset`	Read `read`	Retrieves a preset. Retrieve the details of a preset, given it's name.
`typesense.typesense_retrieve_stopwords_set`	Read `read`	Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name.
`typesense.typesense_retrieve_stopwords_sets`	Read `read`	Retrieves all stopwords sets. Retrieve the details of all stopwords sets
`typesense.typesense_retrieve_synonym_set`	Read `read`	Retrieve a synonym set Retrieve a specific synonym set by its name
`typesense.typesense_retrieve_synonym_set_item`	Read `read`	Retrieve a synonym set item Retrieve a specific synonym item by its id
`typesense.typesense_retrieve_synonym_set_items`	Read `read`	List items in a synonym set Retrieve all synonym items in a set
`typesense.typesense_retrieve_synonym_sets`	Read `read`	List all synonym sets Retrieve all synonym sets
`typesense.typesense_search_documents`	Read `read`	Search for documents in a collection that match the search criteria.
`typesense.typesense_take_snapshot`	Write `write`	Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.
`typesense.typesense_toggle_slow_request_log`	Write `write`	Toggle Slow Request Log Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST.
`typesense.typesense_update_collection`	Write `write`	Update a collection's schema to modify the fields and their types.
`typesense.typesense_update_conversation_model`	Write `write`	Update a conversation model
`typesense.typesense_update_document`	Write `write`	Update a document Update an individual document from a collection by using its ID. The update can be partial.
`typesense.typesense_update_documents`	Write `write`	Update documents with conditional query The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.
`typesense.typesense_update_n_l_search_model`	Write `write`	Update a NL search model Update an existing NL search model.
`typesense.typesense_upsert_alias`	Write `write`	Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.
`typesense.typesense_upsert_analytics_rule`	Write `write`	Upserts an analytics rule with the given name.
`typesense.typesense_upsert_curation_set`	Write `write`	Create or update a curation set with the given name
`typesense.typesense_upsert_curation_set_item`	Write `write`	Create or update a curation set item with the given id
`typesense.typesense_upsert_preset`	Write `write`	Upserts a preset. Create or update an existing preset.
`typesense.typesense_upsert_stopwords_set`	Write `write`	Upserts a stopwords set. When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.
`typesense.typesense_upsert_synonym_set`	Write `write`	Create or update a synonym set with the given name
`typesense.typesense_upsert_synonym_set_item`	Write `write`	Create or update a synonym set item with the given id
`typesense.typesense_vote`	Write `write`	Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds.