Skip to main content
Glama

soundex_encode

Read-onlyIdempotent

Encode words into Soundex phonetic codes, optionally comparing two names to detect similar pronunciation.

Instructions

Encode words using the Soundex phonetic algorithm, optionally comparing two names.

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": {
      "text": "<text>"
    },
    "name": "soundex_encode"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesWord(s) to encode.
compareNoSecond name to compare with the first.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.11

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds one useful behavioral fact - that the tool has a dual mode, either pure encoding or a two-name comparison - but does not say what the comparison returns (a boolean match, a similarity score, or both codes) or what encoding output looks like.

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?

A single front-loaded sentence with no filler; every clause maps to a parameter or mode of the tool.

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?

With no output schema, the description should describe the return value, especially the ambiguous compare mode - it is unclear whether the response contains one Soundex code, two, or a match flag. The algorithmic naming helps, but the output shape is left unstated for a two-mode tool.

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?

Schema description coverage is 100%, so both parameters are already documented with their roles ('Word(s) to encode', 'Second name to compare with the first'). The description only restates that compare is optional and never expands on accepted input forms such as multi-word strings or the significance of comparing a name against an already-encoded value.

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?

States a specific verb (encode) plus the named algorithm (Soundex) and the optional comparison mode, which distinguishes it from adjacent text tools such as metaphone_encode and string_distance. It never names those alternatives explicitly, so the differentiation is implicit rather than stated.

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

Usage Guidelines3/5

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

The phrase 'optionally comparing two names' implies when the compare parameter should be supplied, but there is no guidance on when to pick Soundex over metaphone_encode, phonetic_spell, or similarity tools like jaccard_similarity. Usage must be inferred.

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

Deploy Server

Other Tools