Skip to main content
Glama
redis

Redis MCP Server

Official
by redis

hdel

Delete a field from a Redis hash using its key and field name. Removes the specified field to manage hash data.

Instructions

Delete a field from a Redis hash.

Args: name: The Redis hash key. key: The field name inside the hash.

Returns: A success message or an error message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
keyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The hdel tool handler function that deletes a field from a Redis hash. Decorated with @mcp.tool(), it connects to Redis, executes HDEL, and returns a success/not found/error message.
    @mcp.tool()
    async def hdel(name: str, key: str) -> str:
        """Delete a field from a Redis hash.
    
        Args:
            name: The Redis hash key.
            key: The field name inside the hash.
    
        Returns:
            A success message or an error message.
        """
        try:
            r = RedisConnectionManager.get_connection()
            deleted = r.hdel(name, key)
            return (
                f"Field '{key}' deleted from hash '{name}'."
                if deleted
                else f"Field '{key}' not found in hash '{name}'."
            )
        except RedisError as e:
            return f"Error deleting field '{key}' from hash '{name}': {str(e)}"
  • The schema/type signature of hdel: accepts 'name' (Redis hash key) and 'key' (field name) as string parameters, returns a string.
    @mcp.tool()
    async def hdel(name: str, key: str) -> str:
  • The tool is registered via the @mcp.tool() decorator on the hdel async function.
    @mcp.tool()
  • src/tools/hash.py:7-11 (registration)
    Import of the 'mcp' server object used for the @mcp.tool() decorator.
    from src.common.server import mcp
    
    
    @mcp.tool()
    async def hset(
Behavior2/5

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

No annotations provided, so description carries full burden. It claims 'Delete' which implies destructiveness but does not mention idempotency, behavior on non-existent field, or exact return value (success/error is vague).

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

Conciseness4/5

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

Concise at 6 lines, front-loaded with purpose. However, it includes an 'Args' and 'Returns' section that are structured but not necessary if schema and output schema are present. No wasted words.

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

Completeness3/5

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

For a simple deletion tool, the description is adequate but lacks details on error handling, return format (e.g., integer count), and notes about field existence. The output schema is not used to provide return structure.

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?

Input schema has 0% description coverage. Description adds basic meaning: 'name' is Redis hash key, 'key' is field name. This clarifies but is minimal and expected.

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?

Clearly states it deletes a field from a Redis hash. The verb 'Delete' and resources 'field' and 'Redis hash' are specific. However, it does not explicitly differentiate from similar hash tools like hdel vs hdel (sibling named hset, hget), but the purpose is clear enough.

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?

No guidance on when to use this tool versus alternatives (e.g., srem for sets). No mention of prerequisites like field existence or that this is for removing a single field, not the entire hash.

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/redis/mcp-redis'

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