get_index_advisor_recommendations
Analyzes a SQL++ query with Couchbase Index Advisor and returns recommended secondary and covering indexes for the specified bucket and scope.
Instructions
Get index recommendations from Couchbase Index Advisor for a given SQL++ query.
The Index Advisor analyzes the query and provides recommendations for optimal indexes. This tool works with SELECT, UPDATE, DELETE, or MERGE queries. The queries will be run on the specified scope in the specified bucket.
Returns a dictionary with:
current_used_indexes: Array of currently used indexes (if any)
recommended_indexes: Array of recommended secondary indexes (if any)
recommended_covering_indexes: Array of recommended covering indexes (if any)
Each index object contains:
index: The CREATE INDEX SQL++ command
statements: Array of statement objects with the query and run count
Raises an error carrying the advisor's message if the advisor cannot analyse the statement (for example, a SQL++ syntax error).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"bucket_name": "<bucket_name>",
"scope_name": "<scope_name>",
"query": "<query>"
},
"name": "get_index_advisor_recommendations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| scope_name | Yes | ||
| bucket_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||