Skip to main content
Glama
andyfe76

CouchDB MCP Server

by andyfe76

couchdb_list_indexes

Retrieve all indexes in a CouchDB database to manage query performance and understand database structure for efficient document retrieval.

Instructions

List all indexes in a database

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
databaseYesName of the database

Implementation Reference

  • The _list_indexes handler method that implements the logic to list all indexes in a CouchDB database. It queries the _index endpoint and returns the indexes with metadata.
    async def _list_indexes(self, database: str) -> list[TextContent]:
        """List all indexes in a database."""
        try:
            db = self._get_server()[database]
    
            # Get all indexes
            result = db.resource.get_json('_index')
    
            indexes = result[1].get("indexes", [])
    
            response = {
                "indexes": indexes,
                "count": len(indexes),
                "total_rows": result[1].get("total_rows")
            }
    
            return [TextContent(type="text", text=json.dumps(response, indent=2))]
        except KeyError:
            return [TextContent(type="text", text=f"Database '{database}' not found")]
        except Exception as e:
            return [TextContent(type="text", text=f"Error listing indexes: {str(e)}")]
  • Tool schema definition in list_tools() that defines the couchdb_list_indexes tool with its name, description, and input schema (requires 'database' parameter).
    Tool(
        name="couchdb_list_indexes",
        description="List all indexes in a database",
        inputSchema={
            "type": "object",
            "properties": {
                "database": {
                    "type": "string",
                    "description": "Name of the database",
                },
            },
            "required": ["database"],
        },
    ),
  • Tool registration routing in call_tool() that maps the couchdb_list_indexes tool name to its handler method.
    elif name == "couchdb_list_indexes":
        return await self._list_indexes(arguments["database"])
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While 'List all indexes' implies a read-only operation, it doesn't specify whether this requires specific permissions, what format the output takes (e.g., JSON array), or any limitations (e.g., pagination, rate limits). The description is minimal and lacks essential context for safe invocation.

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, efficient sentence with zero waste. It's front-loaded with the core purpose and appropriately sized for a simple list operation, making it easy to parse 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 lack of annotations and output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., index definitions, status), error conditions, or behavioral nuances. For a tool that likely returns structured data about indexes, 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.

Parameters3/5

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

The input schema has 100% description coverage, with the single parameter 'database' clearly documented. The description adds no additional meaning beyond what the schema provides (e.g., it doesn't clarify database naming conventions or constraints). With high schema coverage, the baseline score of 3 is appropriate.

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 action ('List all indexes') and the resource ('in a database'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'couchdb_list_databases' or 'couchdb_list_documents', which follow similar naming patterns but target different resources.

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 (e.g., database must exist), exclusions, or how it relates to sibling tools like 'couchdb_create_index' or 'couchdb_search_documents' that might involve indexes.

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

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/andyfe76/couchdb_mcp'

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