Skip to main content
Glama
meilisearch

Meilisearch MCP Server

Official
by meilisearch

get-settings

Retrieve current configuration settings for a specific index in Meilisearch, ensuring accurate management and updates to search functionalities.

Instructions

Get current settings for an index

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexUidYes

Implementation Reference

  • Handler for the 'get-settings' MCP tool: retrieves the index settings via the SettingsManager and formats the response as text content.
    elif name == "get-settings":
        settings = self.meili_client.settings.get_settings(
            arguments["indexUid"]
        )
        return [
            types.TextContent(
                type="text", text=f"Current settings: {settings}"
            )
        ]
  • Registration of the 'get-settings' tool in the list_tools handler, including its input schema requiring 'indexUid'.
    types.Tool(
        name="get-settings",
        description="Get current settings for an index",
        inputSchema={
            "type": "object",
            "properties": {"indexUid": {"type": "string"}},
            "required": ["indexUid"],
            "additionalProperties": False,
        },
    ),
  • Implementation of get_settings method in SettingsManager class, which calls the Meilisearch SDK to retrieve index settings.
    def get_settings(self, index_uid: str) -> Dict[str, Any]:
        """Get all settings for an index"""
        try:
            index = self.client.index(index_uid)
            return index.get_settings()
        except Exception as e:
            raise Exception(f"Failed to get settings: {str(e)}")
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a read operation ('Get'), implying it's non-destructive, but doesn't cover aspects like authentication requirements, rate limits, error conditions, or what the output format looks like. This leaves significant gaps for a tool with no structured safety hints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence with no wasted words. It's front-loaded with the core action and resource, making it easy to scan and understand quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (1 parameter, no output schema, no annotations), the description is incomplete. It doesn't explain what 'settings' include, how they're returned, or any dependencies. For a read operation in a system with multiple setting-related tools, more context is needed to use it effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 1 parameter with 0% description coverage, so the schema provides no semantic information. The description mentions 'for an index', which hints that 'indexUid' identifies an index, but doesn't explain what an index is, valid formats for the UID, or where to find it. This adds minimal value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'current settings for an index', making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get-connection-settings' or 'update-settings', which would require more specificity about what type of settings it retrieves.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites like needing an existing index, nor does it compare to siblings such as 'get-connection-settings' for different setting types or 'update-settings' for modifications.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/meilisearch/meilisearch-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server