ESQ Matching Engine

Check a message's status (older name get_referral_status)

get_referral_status

Read-onlyIdempotent

get_referral_status is an older name of get_contact_request_status, kept until 2026-12-15; use get_contact_request_status. Use when the person asks what happened with a message they sent. Returns lifecycle_state (recorded, queued, sent, delivered, responded, consultation_requested, consultation_confirmed, cancelled, completed, failed), whether it reached the lawyer and the lawyer's response. Needs the private status_token. A consultation counts only when confirmed. This is a listing service, not a lawyer referral service. No lawyer pays for placement or ranking of any kind.

Input Schema

Name	Required	Description	Default
`referral_id`	Yes
`status_token`	No	The status_token returned when the message was created

Output Schema

Name	Required	Description	Default
`notice`	Yes
`status`	Yes
`consent`	Yes
`attorney`	Yes
`match_id`	Yes
`next_step`	Yes
`created_at`	Yes
`submission`	Yes
`api_version`	Yes
`destination`	Yes
`referral_id`	Yes
`consultation`	Yes
`last_updated`	Yes
`qualification`	Yes
`delivery_notice`	No
`lifecycle_state`	Yes
`attorney_response`	Yes
`delivered_to_lawyer`	Yes
`personal_details_deleted`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedNov 5, 2026

changedInput schema / properties / status_token / description

Previous value: -"The status_token returned when the introduction was created"New value: +"The status_token returned when the message was created"

Changed32 schema fields changedOct 25, 2026

removedOutput schema / properties / api_version / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / api_version / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```

changedOutput schema / properties / attorney / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "attorney_id": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "firm": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "name": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "profile_url": {
-        "type": [
-          "string",
-          "null"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "attorney_id": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "firm": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "name": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "profile_url": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / attorney_response / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "decision": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "decline_reason": {
-        "type": "null"
-      },
-      "first_substantive_response_at": {
-        "type": [
-          "null",
-          "string"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "decision": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "decline_reason": {
+        "x-observed-types": "null"
+      },
+      "first_substantive_response_at": {
+        "x-observed-types": [
+          "null",
+          "string"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / consent / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "consented_at": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "fields_authorized": {
-        "anyOf": [
-          {
-            "items": {
-              "type": [
-                "string",
-                "null"
-              ]
-            },
-            "type": "array"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "recipient_attorney_id": {
-        "type": [
-          "string",
-          "null"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "consented_at": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "fields_authorized": {
+        "anyOf": [
+          {
+            "items": {
+              "x-observed-types": [
+                "string",
+                "null"
+              ]
+            },
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "recipient_attorney_id": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / consultation / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "confirmed_by": {
-        "type": [
-          "null",
-          "string"
-        ]
-      },
-      "reschedules": {
-        "type": [
-          "number",
-          "null"
-        ]
-      },
-      "scheduled_for": {
-        "type": [
-          "null",
-          "string"
-        ]
-      },
-      "state": {
-        "type": [
-          "string",
-          "null"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "confirmed_by": {
+        "x-observed-types": [
+          "null",
+          "string"
+        ]
+      },
+      "reschedules": {
+        "x-observed-types": [
+          "number",
+          "null"
+        ]
+      },
+      "scheduled_for": {
+        "x-observed-types": [
+          "null",
+          "string"
+        ]
+      },
+      "state": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / created_at / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / created_at / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / delivered_to_lawyer / type
```
Removed value: -[
-  "boolean",
-  "null"
-]
```
addedOutput schema / properties / delivered_to_lawyer / x-observed-types
```
Added value: +[
+  "boolean",
+  "null"
+]
```
removedOutput schema / properties / delivery_notice / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / delivery_notice / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / destination / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / destination / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / last_updated / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / last_updated / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / lifecycle_state / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / lifecycle_state / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / match_id / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / match_id / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / next_step / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / next_step / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / notice / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / notice / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / personal_details_deleted / type
```
Removed value: -[
-  "boolean",
-  "null"
-]
```
addedOutput schema / properties / personal_details_deleted / x-observed-types
```
Added value: +[
+  "boolean",
+  "null"
+]
```

changedOutput schema / properties / qualification / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "status": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "version": {
-        "type": [
-          "string",
-          "null"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "status": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "version": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / referral_id / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / referral_id / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```
removedOutput schema / properties / status / type
```
Removed value: -[
-  "string",
-  "null"
-]
```
addedOutput schema / properties / status / x-observed-types
```
Added value: +[
+  "string",
+  "null"
+]
```

changedOutput schema / properties / submission / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "at": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "note": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "status": {
-        "type": [
-          "string",
-          "null"
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "at": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "note": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      },
+      "status": {
+        "x-observed-types": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

Changed1 schema field changedOct 24, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "api_version": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "attorney": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "attorney_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "firm": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "name": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "profile_url": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "attorney_response": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "decision": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "decline_reason": {
+              "type": "null"
+            },
+            "first_substantive_response_at": {
+              "type": [
+                "null",
+                "string"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "consent": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "consented_at": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "fields_authorized": {
+              "anyOf": [
+                {
+                  "items": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "type": "array"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "recipient_attorney_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "consultation": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "confirmed_by": {
+              "type": [
+                "null",
+                "string"
+              ]
+            },
+            "reschedules": {
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "scheduled_for": {
+              "type": [
+                "null",
+                "string"
+              ]
+            },
+            "state": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "created_at": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "delivered_to_lawyer": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "delivery_notice": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "destination": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "last_updated": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "lifecycle_state": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "match_id": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "next_step": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "notice": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "personal_details_deleted": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "qualification": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "version": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "referral_id": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "status": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "submission": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "properties": {
+            "at": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "note": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "api_version",
+    "referral_id",
+    "status",
+    "lifecycle_state",
+    "delivered_to_lawyer",
+    "match_id",
+    "created_at",
+    "last_updated",
+    "attorney",
+    "destination",
+    "submission",
+    "attorney_response",
+    "consultation",
+    "qualification",
+    "consent",
+    "personal_details_deleted",
+    "next_step",
+    "notice"
+  ],
+  "type": "object"
+}

Changed1 schema field changedOct 21, 2026

changedInput schema / properties / status_token / description

Previous value: -"The status_token returned when the referral was created"New value: +"The status_token returned when the introduction was created"

First observedOct 17, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds meaningful context beyond that: it requires a private status_token, enumerates the full lifecycle_state set, and clarifies that a consultation counts only when confirmed. It doesn't discuss caching, rate limits, or what happens to a token after use, so not a perfect 5.

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?

Front-loads the deprecation notice and migration target, which is the most important information. The later sentences on the listing-service disclaimer are somewhat tangential boilerplate but still earn space by preventing misreading of 'referral'.

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

Completeness4/5

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

An output schema exists so return structure needn't be re-explained, and the description still summarizes the key state values and the token requirement. For a two-parameter, deprecated read tool this is close to complete; only the token's requiredness relative to the schema is left slightly ambiguous.

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 coverage is 50% and the schema documents the status_token's origin and the referral_id pattern. The description only adds that the token is 'private' and 'needed', which nudges it toward being required even though the schema marks only referral_id as required — useful nuance but limited added meaning.

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

Purpose5/5

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

Opens by identifying the tool as a deprecated alias of get_contact_request_status, then states concretely what it returns (lifecycle_state, lawyer delivery, lawyer response). An agent can tell immediately what it does and that it is the legacy name of a sibling.

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

Usage Guidelines5/5

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

Explicitly says 'use get_contact_request_status' and names the deprecation cutoff date (2026-12-15), plus gives the trigger condition: 'when the person asks what happened with a message they sent.' Both the preferred alternative and the use scenario are stated.

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

All ESQ Matching Engine tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?