data
Algolia MCP, CLI, and Lua Integration for AI Agents
Algolia integration docs for AI agents: MCP gateway setup, Algolia CLI commands, Lua API reference, credentials, and function schemas.Algolia 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
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
algolia.algolia_add_api_key | Write write | 1 | Add a restricted Algolia API key with ACLs and optional restrictions. |
algolia.algolia_api_delete | Read read | 2 | Call a safe relative Algolia API path with DELETE for endpoints not covered by a dedicated tool. |
algolia.algolia_api_get | Read read | 3 | Call a safe relative Algolia API path with GET for endpoints not covered by a dedicated tool. |
algolia.algolia_api_post | Read read | 4 | Call a safe relative Algolia API path with POST for endpoints not covered by a dedicated tool. |
algolia.algolia_api_put | Read read | 3 | Call a safe relative Algolia API path with PUT for endpoints not covered by a dedicated tool. |
algolia.algolia_batch | Read read | 2 | Perform multiple write operations (addObject, updateObject, partialUpdateObject, deleteObject) in a single batch request for better performance. |
algolia.algolia_batch_rules | Read read | 3 | Create or update multiple Algolia query rules in one request. |
algolia.algolia_batch_synonyms | Read read | 3 | Create or update multiple Algolia synonyms in one request. |
algolia.algolia_browse | Read read | 2 | Browse records in an Algolia index for exports or complete scans. |
algolia.algolia_clear_index | Read read | 1 | Remove all records from an Algolia index. The index itself is preserved with its settings. This action is irreversible. |
algolia.algolia_clear_rules | Read read | 2 | Clear query rules from an Algolia index. |
algolia.algolia_clear_synonyms | Read read | 2 | Clear synonyms from an Algolia index. |
algolia.algolia_delete_api_key | Write write | 1 | Delete an Algolia API key. |
algolia.algolia_delete_index | Write write | 1 | Delete an Algolia index and all its records. |
algolia.algolia_delete_object | Write write | 2 | Delete a record from an Algolia index by its objectID. This action is irreversible. |
algolia.algolia_delete_rule | Write write | 2 | Delete one Algolia query rule by objectID. |
algolia.algolia_delete_synonym | Write write | 2 | Delete one Algolia synonym by objectID. |
algolia.algolia_get_api_key | Read read | 1 | Get settings and ACLs for one Algolia API key. |
algolia.algolia_get_current_user | Read read | 0 | List API keys for the Algolia application. Use this to verify that authentication is working and to see which API keys exist. |
algolia.algolia_get_object | Read read | 3 | Retrieve a single record from an Algolia index by its objectID. Returns all attributes of the object. |
algolia.algolia_get_rule | Read read | 2 | Get one Algolia query rule by objectID. |
algolia.algolia_get_settings | Read read | 1 | Get the configuration settings of an Algolia index, including searchable attributes, ranking, facets, and more. |
algolia.algolia_get_synonym | Read read | 2 | Get one Algolia synonym by objectID. |
algolia.algolia_get_task | Read read | 2 | Get the status of an Algolia indexing task. |
algolia.algolia_index_operation | Read read | 4 | Run an Algolia index operation such as copy or move to another index. |
algolia.algolia_list_api_keys | Read read | 0 | List Algolia API keys in the application. |
algolia.algolia_list_indices | Read read | 2 | List all indices in the Algolia application. Returns index names, entry counts, and sizes information. |
algolia.algolia_list_logs | Read read | 1 | List recent Algolia logs for API activity and troubleshooting. |
algolia.algolia_partial_update | Read read | 3 | Update specific attributes of a record without replacing the entire object. Only the specified attributes will be changed; all other attributes remain unchanged. |
algolia.algolia_save_object | Read read | 3 | Create or replace a record in an Algolia index. The object is identified by its objectID. If a record with this objectID exists, it will be fully replaced. |
algolia.algolia_save_rule | Read read | 3 | Create or replace an Algolia query rule. |
algolia.algolia_save_synonym | Read read | 3 | Create or replace an Algolia synonym. |
algolia.algolia_search | Read read | 9 | Search an Algolia index. Supports full-text search with filters, faceting, and pagination. Use this to find records matching a query string or filter criteria. |
algolia.algolia_search_facet_values | Read read | 3 | Search values for an Algolia facet attribute. |
algolia.algolia_search_multiple | Read read | 2 | Search multiple Algolia indices in one request using the multiple queries endpoint. |
algolia.algolia_search_rules | Read read | 2 | Search query rules in an Algolia index. |
algolia.algolia_search_synonyms | Read read | 2 | Search synonyms in an Algolia index. |
algolia.algolia_set_settings | Read read | 3 | Update Algolia index settings such as searchableAttributes, ranking, facets, replicas, and typo tolerance. |
algolia.algolia_update_api_key | Write write | 2 | Update ACLs and restrictions for an Algolia API key. |