Skip to main content
Glama

Uk Ons

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Resolve Entity

resolve_entity
Read-onlyIdempotent

"What's the ticker for…" / "find the CIK for…" / "what's the LEI for…" / "what's the RxCUI for…" / "look up the ID for…" / "what is X's official identifier" / "who owns X" / "is X a subsidiary of Y" — resolve a user-spoken NAME to the canonical/official identifiers other tools require as input. Use FIRST whenever you have a name but need an ID. SUPPORTED TYPES: "company" (cross-source identity spine: 10-digit CIK + ticker + company_name from SEC EDGAR, legal-entity LEI from GLEIF with parent/ultimate-parent/children ownership when the LEI resolves, and security FIGI from OpenFIGI — by exact ticker map when a ticker is implied, and otherwise by name search, so NON-EQUITY instruments that never have a ticker (municipal and corporate bonds, notes, authority debt) DO resolve here; when a name matches more than one instrument it asserts nothing and returns figi_candidates to pick from, which is the correct answer to an issuer name that does not identify a single bond; every identifier is labelled with the source that established it, and an identifier that could NOT be resolved is stated explicitly under unresolved rather than omitted — accepts ticker, CIK, ISIN, or company name as input; an ISIN like "CH0038863350" resolves to the LEGAL ENTITY that issued the security via the GLEIF ISIN-to-LEI mapping, covering non-US issuers EDGAR cannot reach), "drug" (returns RxCUI + ingredient + brand from RxNorm + pipeworx://rxnorm/concept/{rxcui} citation; accepts brand or generic name). LEI/FIGI enrichment degrades gracefully — if GLEIF or OpenFIGI is unavailable, the EDGAR identifiers still return. Each call cascades through several lookup endpoints internally — using resolve_entity replaces 2-3 manual lookups.

Input Schema

NameRequiredDescriptionDefault
typeYesEntity type: "company" or "drug".
valueYesFor company: ticker (AAPL), CIK (0000320193), or name. For drug: brand or generic name (e.g., "ozempic", "metformin"). Pass the ENTITY NAME ONLY — for a bond that is the ISSUER exactly as printed ("NEW YORK ST DORM AUTH"), never the question's full noun phrase ("NEW YORK ST DORM AUTH revenue bonds"): the FIGI lookup matches instrument names, so trailing security-class words match nothing.
countryNoOPTIONAL ISO 3166-1 alpha-2 of the country whose business register you mean ("NO", "FI", "JP", "GB", "FR", "EE", "BR"). Narrows the national-register fan-out and is often the difference between the right company and a US namesake — "Apple" with country "NO" is a Norwegian company, not Apple Inc. Omitting it searches every register we can name, which is the right default when you do not know. company only; ignored for drug.

Output Schema

NameRequiredDescriptionDefault
idsYesEvery identifier established: cik, ticker, company_name, lei, figi, isin, cusip, register_id, register_country. A key absent here appears in `unresolved` with a reason — never silently dropped.
typeYes
brandNo
notesNo
queryYes
relatedNoEntities that collapsed INTO the match, each carrying `collapsed_by`.
sourcesYesPer-identifier provenance. Every key in `ids` has a matching key here.
resolvedYesAt least one identifier was established. Read `match_status` and `unresolved` for WHICH — a company can be resolved in a national register with no CIK at all.
searchedNoEVERY register asked, with its own as-of date and row count. A register that could not be reached carries `error` — 0 rows with an error is "we could not ask", 0 rows without one is "nothing is there", and they are different answers.
registersNoThe matched entity as every register that carries it — the match (flagged `matched: true`) plus anything that collapsed into it. A Companies House number AND the LEI that crosswalks to it are the SAME answer, not rivals.
resourcesNo
candidatesNoRivals, best first. Populated on "ambiguous" and on "matched" alike.
ingredientNo
unresolvedYesPer-identifier reason an id could NOT be established — the honest twin of `ids`.
cik_withheldNoA CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate, or `match_status` is "ambiguous" or "incomplete" and the SEC hit was not an exact ticker, CIK or legal name (fleet #3606). The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason.
lei_withheldNoA LEI that is NOT asserted: it matched the bare string exactly in GLEIF, but `match_status` is "ambiguous" or "incomplete" so the registers cannot say which company that string means, and a GLEIF hit on the same string is the same guess from another register. `relationships` is withheld with it. A LEI from an exact SEC hit, or from a complete legal name carrying its legal form, is never withheld. See `unresolved.lei`.
match_statusNoThe headline to branch on. "ambiguous" is an ANSWER, not a failure: two companies matched the name equally well and both are in `candidates`. "no_match" means every register in `searched` was asked and none carried it. "incomplete" means one of them could NOT be asked (it carries an `error` in `searched[]`), so the candidate set is short by an unknown amount and no id is asserted — distinct from "ambiguous" because a RETRY is what resolves it, not a narrower query; `fanout_incomplete` names the unreachable registers and carries, under `withheld_match`, the candidate that would have been returned on a complete fan-out.
figi_withheldNoA FIGI that is NOT asserted. Either it matched this name in OpenFIGI (`figi_match: "name_search"`) while `match_status` is "incomplete" — a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask — or it is a `ticker_map` FIGI whose ticker came from a FUZZY SEC name match that is itself withheld (`cik_withheld`), so the mapping inherits the doubt. A `ticker_map` FIGI from an EXACT SEC hit (a real ticker, a CIK, an exact legal name) is never withheld. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`.
match_scoringNoThe margin rule's own inputs, so a caller can see WHY it fell where it did.
ticker_withheldNoThe ticker of a FUZZY SEC name match that is NOT asserted, withheld together with `cik_withheld` because it is the same guess. Carried so a caller who meant the US filer can still use it; see `unresolved.ticker`.
sec_alternativesNoEDGAR's other name-matching candidates: distinct companies, deduped by CIK, excluding this issuer's own share classes — surfaced instead of dropped so a caller can tell a genuinely CONTESTED name match from a clean one.
fanout_incompleteNoPresent IFF at least one register in `searched[]` carried an `error` — set even when `match_status` stayed "ambiguous". `withheld_match` is the candidate this call declined to ASSERT because a register was missing, carried rather than discarded so a caller who accepts the caveat can still use it.
match_explanationNoPlain words. Always present when the spine ran, and required on "ambiguous" and "no_match".
company_name_withheldNoThe company name of a FUZZY SEC name match that is NOT asserted, withheld together with `cik_withheld`. See `unresolved.cik`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / sec_alternatives / description
      Previous value: -"EDGAR's own discarded near-misses on a name match, surfaced instead of dropped."New value: +"EDGAR's other name-matching candidates: distinct companies, deduped by CIK, excluding this issuer's own share classes — surfaced instead of dropped so a caller can tell a genuinely CONTESTED name match from a clean one."
  2. Changed5 schema fields changed
    • changedOutput schema / properties / cik_withheld / description
      Previous value: -"A CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate. The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason."New value: +"A CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate, or `match_status` is \"ambiguous\" or \"incomplete\" and the SEC hit was not an exact ticker, CIK or legal name (fleet #3606). The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason."
    • addedOutput schema / properties / company_name_withheld
      Added value: +{
+  "description": "The company name of a FUZZY SEC name match that is NOT asserted, withheld together with `cik_withheld`. See `unresolved.cik`.",
+  "type": "string"
+}
    • changedOutput schema / properties / figi_withheld / description
      Previous value: -"A FIGI that matched this name in OpenFIGI (`figi_match: \"name_search\"`) and is NOT asserted, because `match_status` is \"incomplete\": a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask. A `ticker_map` FIGI is never withheld this way — it is corroborated by the resolved ticker it came from. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`, and retry, since a transiently rate-limited register completes on the next call."New value: +"A FIGI that is NOT asserted. Either it matched this name in OpenFIGI (`figi_match: \"name_search\"`) while `match_status` is \"incomplete\" — a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask — or it is a `ticker_map` FIGI whose ticker came from a FUZZY SEC name match that is itself withheld (`cik_withheld`), so the mapping inherits the doubt. A `ticker_map` FIGI from an EXACT SEC hit (a real ticker, a CIK, an exact legal name) is never withheld. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`."
    • addedOutput schema / properties / lei_withheld
      Added value: +{
+  "description": "A LEI that is NOT asserted: it matched the bare string exactly in GLEIF, but `match_status` is \"ambiguous\" or \"incomplete\" so the registers cannot say which company that string means, and a GLEIF hit on the same string is the same guess from another register. `relationships` is withheld with it. A LEI from an exact SEC hit, or from a complete legal name carrying its legal form, is never withheld. See `unresolved.lei`.",
+  "type": "string"
+}
    • addedOutput schema / properties / ticker_withheld
      Added value: +{
+  "description": "The ticker of a FUZZY SEC name match that is NOT asserted, withheld together with `cik_withheld` because it is the same guess. Carried so a caller who meant the US filer can still use it; see `unresolved.ticker`.",
+  "type": "string"
+}
  3. Changed2 schema fields changed
    • addedInput schema / properties / country
      Added value: +{
+  "description": "OPTIONAL ISO 3166-1 alpha-2 of the country whose business register you mean (\"NO\", \"FI\", \"JP\", \"GB\", \"FR\", \"EE\", \"BR\"). Narrows the national-register fan-out and is often the difference between the right company and a US namesake — \"Apple\" with country \"NO\" is a Norwegian company, not Apple Inc. Omitting it searches every register we can name, which is the right default when you do not know. company only; ignored for drug.",
+  "type": "string"
+}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "brand": {
+      "type": "string"
+    },
+    "candidates": {
+      "description": "Rivals, best first. Populated on \"ambiguous\" and on \"matched\" alike.",
+      "items": {
+        "properties": {
+          "country": {
+            "description": "ISO-2 of the REGISTER, not of the company's operations.",
+            "type": "string"
+          },
+          "data_as_of": {
+            "description": "That register's own snapshot date, per row, so a stale country is visible.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "detail_tool": {
+            "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_form": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_name": {
+            "type": "string"
+          },
+          "lei": {
+            "description": "From the GLEIF crosswalk when present. Never guessed from a name.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "match_type": {
+            "enum": [
+              "id",
+              "exact",
+              "exact_form",
+              "prefix",
+              "tokens"
+            ],
+            "type": "string"
+          },
+          "matched_kind": {
+            "enum": [
+              "legal",
+              "trading",
+              "former",
+              "english",
+              "kana"
+            ],
+            "type": "string"
+          },
+          "matched_name": {
+            "description": "The name row that matched, exactly as the publisher spells it.",
+            "type": "string"
+          },
+          "register": {
+            "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.",
+            "type": "string"
+          },
+          "register_id": {
+            "description": "The native id in the register's own canonical formatting.",
+            "type": "string"
+          },
+          "register_key": {
+            "description": "Stable machine slug for the register.",
+            "type": "string"
+          },
+          "registration_status": {
+            "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "score": {
+            "description": "0-1, assigned centrally. An adapter never grades itself.",
+            "type": "number"
+          },
+          "status": {
+            "description": "The COMPANY's status.",
+            "enum": [
+              "active",
+              "inactive",
+              "dissolved",
+              "unknown"
+            ],
+            "type": "string"
+          },
+          "status_raw": {
+            "description": "The register's own status word, verbatim and unglossed.",
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "country",
+          "register",
+          "register_key",
+          "register_id",
+          "legal_name",
+          "score",
+          "status"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "cik_withheld": {
+      "description": "A CIK that came back from a FUZZY SEC name match and is NOT asserted, because the spine matched a stronger non-US candidate. The number is here so a caller who wanted the US filer can still use it; what changed is that we no longer claim it IS the answer. See `unresolved.cik` for the reason.",
+      "type": "string"
+    },
+    "fanout_incomplete": {
+      "description": "Present IFF at least one register in `searched[]` carried an `error` — set even when `match_status` stayed \"ambiguous\". `withheld_match` is the candidate this call declined to ASSERT because a register was missing, carried rather than discarded so a caller who accepts the caveat can still use it.",
+      "properties": {
+        "unavailable": {
+          "items": {
+            "properties": {
+              "country": {
+                "type": "string"
+              },
+              "error": {
+                "type": "string"
+              },
+              "register": {
+                "type": "string"
+              },
+              "register_key": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "withheld_match": {
+          "type": [
+            "object",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "figi_withheld": {
+      "description": "A FIGI that matched this name in OpenFIGI (`figi_match: \"name_search\"`) and is NOT asserted, because `match_status` is \"incomplete\": a name search cannot tell a company apart from a security carrying its name, and the registers that would have settled it are the ones we could not ask. A `ticker_map` FIGI is never withheld this way — it is corroborated by the resolved ticker it came from. Carried so a caller who accepts the caveat can use it; see `unresolved.figi`, and retry, since a transiently rate-limited register completes on the next call.",
+      "type": "string"
+    },
+    "ids": {
+      "description": "Every identifier established: cik, ticker, company_name, lei, figi, isin, cusip, register_id, register_country. A key absent here appears in `unresolved` with a reason — never silently dropped.",
+      "type": "object"
+    },
+    "ingredient": {
+      "type": "string"
+    },
+    "match_explanation": {
+      "description": "Plain words. Always present when the spine ran, and required on \"ambiguous\" and \"no_match\".",
+      "type": "string"
+    },
+    "match_scoring": {
+      "description": "The margin rule's own inputs, so a caller can see WHY it fell where it did.",
+      "properties": {
+        "margin": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "runner_up": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "thresholds": {
+          "properties": {
+            "floor": {
+              "type": "number"
+            },
+            "margin": {
+              "type": "number"
+            },
+            "match": {
+              "type": "number"
+            }
+          },
+          "type": "object"
+        },
+        "top": {
+          "type": [
+            "number",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "match_status": {
+      "description": "The headline to branch on. \"ambiguous\" is an ANSWER, not a failure: two companies matched the name equally well and both are in `candidates`. \"no_match\" means every register in `searched` was asked and none carried it. \"incomplete\" means one of them could NOT be asked (it carries an `error` in `searched[]`), so the candidate set is short by an unknown amount and no id is asserted — distinct from \"ambiguous\" because a RETRY is what resolves it, not a narrower query; `fanout_incomplete` names the unreachable registers and carries, under `withheld_match`, the candidate that would have been returned on a complete fan-out.",
+      "enum": [
+        "matched",
+        "ambiguous",
+        "no_match",
+        "incomplete"
+      ],
+      "type": "string"
+    },
+    "notes": {
+      "type": "string"
+    },
+    "query": {
+      "type": "string"
+    },
+    "registers": {
+      "description": "The matched entity as every register that carries it — the match (flagged `matched: true`) plus anything that collapsed into it. A Companies House number AND the LEI that crosswalks to it are the SAME answer, not rivals.",
+      "items": {
+        "properties": {
+          "country": {
+            "description": "ISO-2 of the REGISTER, not of the company's operations.",
+            "type": "string"
+          },
+          "data_as_of": {
+            "description": "That register's own snapshot date, per row, so a stale country is visible.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "detail_tool": {
+            "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_form": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_name": {
+            "type": "string"
+          },
+          "lei": {
+            "description": "From the GLEIF crosswalk when present. Never guessed from a name.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "match_type": {
+            "enum": [
+              "id",
+              "exact",
+              "exact_form",
+              "prefix",
+              "tokens"
+            ],
+            "type": "string"
+          },
+          "matched_kind": {
+            "enum": [
+              "legal",
+              "trading",
+              "former",
+              "english",
+              "kana"
+            ],
+            "type": "string"
+          },
+          "matched_name": {
+            "description": "The name row that matched, exactly as the publisher spells it.",
+            "type": "string"
+          },
+          "register": {
+            "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.",
+            "type": "string"
+          },
+          "register_id": {
+            "description": "The native id in the register's own canonical formatting.",
+            "type": "string"
+          },
+          "register_key": {
+            "description": "Stable machine slug for the register.",
+            "type": "string"
+          },
+          "registration_status": {
+            "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "score": {
+            "description": "0-1, assigned centrally. An adapter never grades itself.",
+            "type": "number"
+          },
+          "status": {
+            "description": "The COMPANY's status.",
+            "enum": [
+              "active",
+              "inactive",
+              "dissolved",
+              "unknown"
+            ],
+            "type": "string"
+          },
+          "status_raw": {
+            "description": "The register's own status word, verbatim and unglossed.",
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "country",
+          "register",
+          "register_key",
+          "register_id",
+          "legal_name",
+          "score",
+          "status"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "related": {
+      "description": "Entities that collapsed INTO the match, each carrying `collapsed_by`.",
+      "items": {
+        "properties": {
+          "country": {
+            "description": "ISO-2 of the REGISTER, not of the company's operations.",
+            "type": "string"
+          },
+          "data_as_of": {
+            "description": "That register's own snapshot date, per row, so a stale country is visible.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "detail_tool": {
+            "description": "The live pack tool that returns the full record, e.g. \"brreg-no:get_entity\".",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_form": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "legal_name": {
+            "type": "string"
+          },
+          "lei": {
+            "description": "From the GLEIF crosswalk when present. Never guessed from a name.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "match_type": {
+            "enum": [
+              "id",
+              "exact",
+              "exact_form",
+              "prefix",
+              "tokens"
+            ],
+            "type": "string"
+          },
+          "matched_kind": {
+            "enum": [
+              "legal",
+              "trading",
+              "former",
+              "english",
+              "kana"
+            ],
+            "type": "string"
+          },
+          "matched_name": {
+            "description": "The name row that matched, exactly as the publisher spells it.",
+            "type": "string"
+          },
+          "register": {
+            "description": "Publisher + dataset, e.g. \"Brønnøysund Register Centre, Enhetsregisteret\". Never a URL or filename.",
+            "type": "string"
+          },
+          "register_id": {
+            "description": "The native id in the register's own canonical formatting.",
+            "type": "string"
+          },
+          "register_key": {
+            "description": "Stable machine slug for the register.",
+            "type": "string"
+          },
+          "registration_status": {
+            "description": "GLEIF rows only: the LEI RECORD's lifecycle (ISSUED/LAPSED/RETIRED/...). A DIFFERENT fact from `status` — a lapsed LEI is unmaintained reference data about a company that may well still trade.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "score": {
+            "description": "0-1, assigned centrally. An adapter never grades itself.",
+            "type": "number"
+          },
+          "status": {
+            "description": "The COMPANY's status.",
+            "enum": [
+              "active",
+              "inactive",
+              "dissolved",
+              "unknown"
+            ],
+            "type": "string"
+          },
+          "status_raw": {
+            "description": "The register's own status word, verbatim and unglossed.",
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "country",
+          "register",
+          "register_key",
+          "register_id",
+          "legal_name",
+          "score",
+          "status"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "resolved": {
+      "description": "At least one identifier was established. Read `match_status` and `unresolved` for WHICH — a company can be resolved in a national register with no CIK at all.",
+      "type": "boolean"
+    },
+    "resources": {
+      "type": "object"
+    },
+    "searched": {
+      "description": "EVERY register asked, with its own as-of date and row count. A register that could not be reached carries `error` — 0 rows with an error is \"we could not ask\", 0 rows without one is \"nothing is there\", and they are different answers.",
+      "items": {
+        "properties": {
+          "country": {
+            "type": "string"
+          },
+          "data_as_of": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "error": {
+            "type": "string"
+          },
+          "register": {
+            "type": "string"
+          },
+          "register_key": {
+            "type": "string"
+          },
+          "rows": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "register",
+          "register_key",
+          "country",
+          "rows"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "sec_alternatives": {
+      "description": "EDGAR's own discarded near-misses on a name match, surfaced instead of dropped.",
+      "items": {
+        "properties": {
+          "cik": {
+            "type": "string"
+          },
+          "company_name": {
+            "type": "string"
+          },
+          "ticker": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "sources": {
+      "description": "Per-identifier provenance. Every key in `ids` has a matching key here.",
+      "type": "object"
+    },
+    "type": {
+      "type": "string"
+    },
+    "unresolved": {
+      "description": "Per-identifier reason an id could NOT be established — the honest twin of `ids`.",
+      "type": "object"
+    }
+  },
+  "required": [
+    "type",
+    "query",
+    "resolved",
+    "ids",
+    "sources",
+    "unresolved"
+  ],
+  "type": "object"
+}
  4. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "type": "company",
+    "value": "AAPL"
+  }
+]
  5. Changed1 schema field changed
    • changedInput schema / properties / value / description
      Previous value: -"For company: ticker (AAPL), CIK (0000320193), or name. For drug: brand or generic name (e.g., \"ozempic\", \"metformin\")."New value: +"For company: ticker (AAPL), CIK (0000320193), or name. For drug: brand or generic name (e.g., \"ozempic\", \"metformin\"). Pass the ENTITY NAME ONLY — for a bond that is the ISSUER exactly as printed (\"NEW YORK ST DORM AUTH\"), never the question's full noun phrase (\"NEW YORK ST DORM AUTH revenue bonds\"): the FIGI lookup matches instrument names, so trailing security-class words match nothing."
  6. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive, openWorld), and the description adds substantial context beyond them: graceful degradation when GLEIF/OpenFIGI are down while EDGAR identifiers still return, explicit `unresolved` reporting instead of silent omission, `figi_candidates` when a name is ambiguous, and per-identifier source labelling. These are exactly the behavioral traits an agent needs to interpret partial or ambiguous results.

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

Conciseness3/5

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

The opening user-phrasing list and the "Use FIRST" rule are well front-loaded, but the company paragraph is a single dense run-on stuffed with nested parentheticals that is hard to parse in one pass. Nearly all the content earns its place, yet the structure could be split into shorter sentences or bullet-style clauses without losing information.

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

Completeness5/5

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

With an output schema present and annotations covering the safety profile, the description supplies everything else an agent needs: supported types, accepted input formats per type, ambiguity handling, degradation behavior, and the country-scoping caveat. Nothing material about correct invocation is left unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

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

Schema coverage is 100%, so a 3 is the baseline, but the description adds real meaning beyond the schema: it reveals that `value` also accepts an ISIN (the schema only lists ticker/CIK/name) and explains the ISIN-to-LEI path for non-US issuers. The drug type semantics (brand or generic → RxCUI + ingredient + brand) also go beyond the enum description.

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?

The description gives a specific verb (resolve) and resource (a spoken NAME to canonical identifiers) plus representative user phrasings, and it enumerates the two supported entity types with the exact fields each returns (CIK/ticker/LEI/FIGI vs RxCUI). It also implicitly separates itself from siblings like entity_profile and company_facts by positioning this as the identifier-lookup step rather than a profile.

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

Usage Guidelines4/5

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

"Use FIRST whenever you have a name but need an ID" is an explicit sequencing rule, and the note that it replaces 2-3 manual lookups tells the agent not to chain lower-level lookups. The country parameter's when-to-use guidance is present. What's missing is naming an alternative sibling (e.g. entity_profile or company_register_search) and the condition that would select it.

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

All Uk Ons toolsInspect
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