searchEnums

Search enum types by name, values, or description.

read-onlyany connectionsweeps instancesweeps group

Synopsis

searchEnums(web_search)

Description

Search enum types by name, values, or description.

Parameters

web_search requiredstring

full-text search, not a substring: websearch_to_tsquery syntax in English, so words are stemmed (users finds user), "a phrase" in double quotes must match in order, or between words means either, and -word excludes. A fragment of a word does not match. Matched against enum type names split into words at underscores and capitals, their comments and their values

Also accepts connection, instance, group, described once under arguments every tool takes.

Output

Keyed by enum type name; each value is that enum's ordered values. An absent extension or a missing grant is reported as {error, hint} in place of the map.

Scope

A physical replica is byte-identical here, so asking each member of a replication group adds nothing.

Example mocked data

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "searchEnums",
    "arguments": {
      "web_search": "voucher"
    }
  }
}

Result

{
  "payment_method": {
    "description": "How an order was paid.",
    "values": [
      "card",
      "transfer",
      "voucher"
    ]
  }
}

Invented values on a fictional shop database, shaped by and checked against this tool's output schema. Real output is returned as structuredContent to clients that negotiate MCP 2025-06-18 or later.

See also

searchTables, searchFunctions