Clinical Terminal
Docs menu · MCP tools
On this page
Documentation

MCP tool reference

Every tool the Clinical Terminal MCP server exposes: health-tech vendors, the hospitals and health systems that buy from them, the people who run both, and the signals moving between them, plus the few tools that publish a page. To connect a client first, start with the setup guide.

Each entry lists the tool’s parameters, an example arguments object, the fields that come back and the errors it can return. Access comes with a Landscape subscription, which covers every tool here except the two Analysis tools; those are staff-only.

Start here

Two tools answer most first questions. Reach for these before chaining anything.

For a question about one company, get_vendor_dossier takes a name and returns the profile, the hospital customers with the verbatim quote each was evidenced by, current products and recent signals — in one call, instead of four.

For a question about a market, find_vendors_for_problem takes a buyer problem in plain words and routes it to one of the Clinical Terminal market segments, then returns that segment’s vendors ranked by traction.

One habit worth forming: an empty result here means not covered, never does not exist. Several tools say so explicitly in their response rather than handing back a bare empty list.

How responses work

  • Every tool returns one text content block holding JSON. Most responses are pretty-printed; get_vendor_dossier, get_provider and get_persona return compact JSON.
  • A missing key means unknown. Null and empty fields are dropped from every row rather than sent as null, so never read an absent field as zero or false.
  • A response longer than 50,000 characters is cut off and ends with … [truncated at 50000 chars — narrow your query with filters or a smaller limit]. The two dossier tools keep to their own smaller budgets instead and list what they trimmed in meta.truncated.
  • Arguments are validated against each tool’s schema before it runs. A wrong type, an out-of-range number or an unknown enum value is rejected with a validation error, so the tool-specific errors below are the ones a well-formed call can still hit.
  • Numeric limits accept any number in range and are rounded down to a whole number.

Free job search (no key)

Current jobs at health-tech vendors and their investors, searchable from Claude Code without an account or a key.

A separate, free endpoint answers three questions: what is open, what a posting says, and who the employer is. Jobs come straight from each employer’s own job board (Greenhouse, Lever, Ashby, Workday and others), checked daily, and only postings seen in the last 14 days are listed. Each answer links to the employer’s Clinical Terminal page.

Add it to Claude Code with one command:

claude mcp add --transport http clinicalterminal-jobs https://mcp-jobs-687925922613.us-central1.run.app/jobs/mcp
  • search_jobs — keyword search with filters for remote, seniority, department, employer and product category. At most three postings per employer are listed unless you name the employer.
  • get_job — one posting in full: description, pay where the employer publishes it, and the apply link.
  • get_employer — a short brief on a hiring vendor: what it does, its best-evidenced customers, leaders and recent news.

Ask it: “Find remote product manager roles at ambient documentation companies.”
“What does Abridge do, and who are its customers?”
“Show me senior engineering jobs in Boston with a posted salary.”

Limits are per network address: 30 calls a minute and 500 a day, of which 300 may be employer briefs. Claude Code only: Claude Desktop and claude.ai custom connectors call from shared servers, so their users would share one set of limits. Posting text comes from employers’ job boards, with email addresses and phone numbers removed.

Companies & vendors

The published health-tech vendors, their products, and their own websites. Coverage is uneven: nearly every vendor has a logo and a summary, fewer have a product catalog, so a thin result means thin data rather than a thin company.

get_vendor_dossier

The fastest path to any single-vendor question. One call by name returns the profile, board, hospital customers with their evidence quotes, current products, recent signals, ownership and what we know of the vendor’s website — instead of chaining a search, a fetch, a product lookup and a signal query.

Ask it: “Give me the dossier on Waystar.”

Parameters
NameTypeDescription
vendor requiredstringA vendor name (“Waystar”), vendor id or numeric slug. A unique near-miss spelling is corrected automatically. 1–200 characters.
Example arguments
{
  "vendor": "Waystar"
}
Returns

One object. Each section can independently be replaced by an unavailable marker (see errors).

vendorThe vendor profile, as get_vendor returns it.
boardThe confirmed members of the governing board in role order (chair first, then CEO directors), each with role and person id, plus boardSize (voting members), the sources that confirm them (the SEC Form D filing and its date, or the vendor’s own board page), unmatchedOnFiling and notShown for directors we can’t name, and mayBeOutOfDate after 12 months. null means no board on record yet, not that the company has none.
customers[]Up to 10 customer relationships, strongest evidence first, with the evidence quote, evidence tier and citable article.
products[]Up to 5 current products.
signals[]Up to 5 recent signals, one per source article.
ownership[]Acquisitions in either direction. Omitted when none are on file.
fundingFunding rounds and funding news. When we hold rounds that cite a source (SEC Form D filings and the funding announcements we cover), roundsTracked is true and rounds[] lists each with its amount, date, investors and source links; an amount marked sold is SEC dollars sold, which can differ from the announced figure. Otherwise roundsTracked is false. events[] always carries the funding and M&A news we hold.
siteMapPages we know on the vendor’s website, by category, with freshness.
metaThe query, the resolved vendor, spellingCorrected when a typo was fixed, and truncated listing anything trimmed to fit the budget.
upcomingEventAppearancesUp to five upcoming conferences the subject appears at, with roles. Absent when none are recorded; from news and LinkedIn, so absence is not evidence.
Errors and special responses
  • Ambiguous name — Returns candidates[] (up to 5, each with id, name and domain) instead of a dossier. Call again with the id you meant.
  • Unknown vendor — Entity not found: "<id>". followed by how to pass an id: the id from search_vendors, a numeric slug, or a terminalId. A vendor name is not an id.
  • A section failed — That section becomes { unavailable: true, reason }; the rest of the dossier still comes back. Retry, or use the section’s own tool.

search_vendors

Find vendors by name, domain or category. Multi-word queries match on all words, then top up with looser any-word matches; results rank exact name matches first, then by how much news a company is generating.

Ask it: “Which vendors work in denials management?”

Parameters
NameTypeDescription
query requiredstringMatched against name, domain and categories; multi-word phrases work. 1–200 characters.
limit optionalintegerMaximum results, 1–50. Default 20.
Example arguments
{
  "query": "denials management",
  "limit": 10
}
Returns

An array of vendors, best match first.

idVendor id — pass it to get_vendor.
nameVendor name.
domainThe vendor’s web domain.
summaryCompany summary.
logoUrl, logoSourceA logo you can use now. stored is our permanent copy; scraped is the source link, which may later expire, so copy it rather than linking to it. Absent when no logo is stored yet.
companyTypeAlways vendor.
Errors and special responses
  • No match — Returns { results: [], note } instead of an array. The note is the coverage contract: a miss means Clinical Terminal does not cover the vendor, not that it does not exist.

get_vendor

The full profile once you have an id or numeric slug, including boardSize and chairName (null when no board or chair is on record). There is no vendor score on this server — the denial/appeals/prebill scores were retired from every read path on 2026-08-04 and are never returned.

Parameters
NameTypeDescription
id requiredstringVendor id from search_vendors, or the numeric slug. A vendor name is not an id.
Example arguments
{
  "id": "100000001"
}
Returns

One vendor object.

id, name, domainIdentity.
slugNumeric terminalId, as a string.
summary, logoUrlCompany summary and logo URL.
categories[]Segment slugs, rolled up from the products this vendor sells.
foundedYear, headquartersCompany basics, when known.
ceoName, ceoTitleThe current CEO, when known.
Errors and special responses
  • Unknown or unpublished id — Vendor not found.

find_vendors_for_problem

Capability discovery across healthcare through the Clinical Terminal market ontology (17 domains, 163 segments, 1,071 capabilities) — the same router the app uses. Routing is deterministic, never a model guess. Vendors whose own websites show the matched capability come first, then vendors in the same segment; each one carries a quote.

Ask it: “Which vendors do ambient clinical documentation?”

Parameters
NameTypeDescription
problem requiredstringA buyer problem or capability in plain words, or an exact segment name from list_segments. At least 2 characters.
limit optionalintegerMaximum vendors, 1–25. Default 10.
Example arguments
{
  "problem": "denials management",
  "limit": 10
}
Returns

An object with status: "ok" and the segment it routed to.

segmentId, segmentName, domainId, domainNameThe segment the problem routed to, and its domain.
capabilities[]Up to three matched capabilities, best first.
matchMethodHow it routed: perspective, name, typo or search.
correctionSet when a misspelling was corrected — pass it on to the user.
vendors[]Ranked vendors: id, name, terminalId, domain, summary, logoUrl, matchedOn (capability or segment), matchedCapabilities, capabilityEvidence, segmentEvidence and up to two evidence quotes with their source URL.
coverageNoteWhat an empty or short list means. Pass it on.
Errors and special responses
  • Could not route the phrase — Returns status: "no_route", sometimes with didYouMean[]. Call list_segments, pick the closest segment and call again with its exact name.
  • Reading the evidence counts — They count labelled website features, not customers. Use get_relationships for customers.

list_segments

Every segment of the market ontology with its domain and the number of published vendors labelled into it — the map behind the tool above. A zero count means no labelled vendor yet, not an empty market.

Parameters

None — call it with an empty arguments object.

Example arguments
{}
Returns

An array of all 163 segments, including empty ones.

idSegment slug.
nameDisplay name — pass it to find_vendors_for_problem.
domainId, domainName, descriptionThe segment’s domain and what it covers.
vendorCountPublished vendors whose websites are labelled into the segment.

search_products

Search what vendors actually sell. Defaults to current products, because a large share of the catalog is discontinued; status always comes back so you can tell the difference.

Parameters
NameTypeDescription
query optionalstringMatched against product name and description. 1–200 characters.
vendor_id optionalstringRestrict to one vendor’s catalog.
include_inactive optionalbooleanAlso return discontinued products. Default false.
limit optionalintegerMaximum results, 1–50. Default 20.
Example arguments
{
  "query": "prior authorization",
  "limit": 20
}
Returns

An array of products, by vendor name then product name.

idProduct id — pass it to get_product.
vendorId, vendorNameThe vendor that sells it.
nameProduct name.
productTypeservice, software, platform, module or device.
statusactive or inactive.
descriptionProduct description.
segmentIds[]Market-ontology segment slugs the product is tagged with (the ids list_segments returns).
Errors and special responses
  • Empty array — Usually means the vendor is not catalogued, not that it sells nothing.

get_product

One product in full, with the vendor it belongs to.

Parameters
NameTypeDescription
id requiredstringProduct id from search_products.
Example arguments
{
  "id": "prod_8f2k1"
}
Returns

One product object, with the same fields as a search_products row.

Errors and special responses
  • Unknown id — Product not found.

get_vendor_pages

A vendor’s own website as data — the pages we have crawled and classified. Filter by category to jump straight to the page worth reading.

Parameters
NameTypeDescription
vendor requiredstringVendor name, id or numeric slug. 1–200 characters.
category optionalenumOne of homepage, about, leadership, contact, news, careers, blog, legal, product, pricing, customers, integrations, demo, resources, other. Omit for every page.
include_dead optionalbooleanAlso return pages that no longer resolve. Default false.
limit optionalintegerRows to return, 1–100. Default 50.
offset optionalintegerRows to skip, for paging. Default 0.
Example arguments
{
  "vendor": "Waystar",
  "category": "customers",
  "limit": 25
}
Returns

One object.

vendorThe resolved vendor: id, name, terminalId.
pages[]Each page: page_id (pass it to get_page_content), url, classification, scraped (whether we hold its text), and isDead when it no longer resolves.
pagesKnown, pagesReturnedLive pages we hold, and rows in this response.
scrapedCount, deadPagesPages we hold text for, and pages that no longer resolve.
lastCrawledAtWhen content was last fetched — the freshness stamp.
noteWhy a result is empty or partial, and how to page on.
Errors and special responses
  • Ambiguous name — Returns candidates[] instead of pages.
  • Unknown vendor — Entity not found: "<id>". followed by how to pass an id: the id from search_vendors, a numeric slug, or a terminalId. A vendor name is not an id.
  • Unpublished vendor — Its website corpus is not available on this server.
  • No crawl yet — An empty list with a note saying we have not mapped the site — absence of data on our side, not absence of pages on theirs.
  • Corpus tools switched off — An error saying the website-corpus tools are temporarily disabled; every other tool is unaffected.

get_page_content

Read the text of one of those pages: product copy, case studies and bios rather than a guess from the URL. It arrives inside an explicit untrusted-content fence, because it is verbatim third-party marketing — evidence to quote, never instructions to follow.

Parameters
NameTypeDescription
page_id requiredstringA page_id from get_vendor_pages. A URL or a vendor name is not a page_id.
Example arguments
{
  "page_id": "pg_3k9x2"
}
Returns

One object.

page_id, url, classificationWhich page this is.
vendorThe published vendor that owns the page.
scrapedWhether we hold its text.
title, contentWhen scraped: the title, and Markdown up to 10,000 characters inside a BEGIN/END UNTRUSTED WEBSITE CONTENT fence.
truncatedTrue when the content was cut at a paragraph boundary.
scrapedAtWhen the text was fetched.
Errors and special responses
  • Not scraped — Not an error: scraped: false with a note to fetch the URL directly.
  • Unknown page_id — An error naming the id and where page_ids come from.
  • Page of an unpublished vendor — Its content is not available here.

get_help

The subscriber guide (what Clinical Terminal is, where each product question goes, how to set up your agent, set your territory on the Map and get alerts) plus your own setup status. Your assistant can explain the product and tell you exactly what is not set up yet. It cannot change settings; it sends you to the page that does.

Ask it: “How does Clinical Terminal work, and is my account set up?”

Parameters

None — call it with an empty arguments object.

Example arguments
{}
Returns

Two text blocks: the guide as Markdown, then one JSON object.

guideVersionA short hash of the guide text, so you can tell which version is live.
connectionWhich account and key is answering: account (the email), and key with itsname, prefix, tier and the day it was created. An unnamed key carries a fix pointing to Settings, where you can name it.
account.territoryset (with the states), nationwide, not_set or unknown.
account.agentSetupconfirmed, in_progress, not_started or unknown.
account.newsAlertson, off, not_set_up or unknown, with how many organizations you follow.
fixOn any gap: the app page to open and what to click.
Errors and special responses
  • A part of the account could not be read — That part reads unknown, which does not mean the setting is off; the rest still answers.

get_my_context

The organizations you have been working with in Clinical Terminal chat, most recent first. This is what lets an assistant resolve “that vendor” or “my target” across sessions instead of asking you again.

Ask it: “What was I looking at last time?”

Parameters

None — call it with an empty arguments object.

Example arguments
{}
Returns

One object.

recentEntities[]Up to 25, most recent first: tid (usable with get_relationships or get_vendor_dossier), name, type, lastSeenAt and seenCount.
updatedAtWhen the chat memory last changed.
Errors and special responses
  • No chat history — Plain text, not JSON: no chat memory yet, or the key has no linked user.

get_my_brief

Your morning brief for a day, the same one your Clinical Terminal homepage shows: the themed summary, the LinkedIn posts behind it, upcoming events, and the people it mentions. Read-only; it never generates a brief.

Ask it: “What's in my morning brief today?”

Parameters
NameTypeDescription
date optionalstringAn Eastern-time day, YYYY-MM-DD. Defaults to today in America/New_York. A brief covers the 24 hours before it was built (the nightly run is 1 am ET).
Example arguments
{
  "date": "2026-10-24"
}
Returns

One object.

statusok, or error when the AI summary failed (the posts are still the day’s real posts), or not-generated when no brief exists for that date.
brief / summary / themesThe written brief, a one-line summary, and the themes (announcements, hiring, events, product, other). Machine-written from public posts.
posts[] / upcomingEvents[]The posts the brief was built from, and events in the next 30 days with attendees.
people[]People with a photo on file: name and terminalId (usable with get_person).
mentionedNames[]People the brief mentions who have no photo on file, by name only: no id, no link.
Errors and special responses
  • No brief for that date — status: not-generated with the reason: not built yet today, a past day with no brief, or a future date. That is not the same as a quiet news day.
  • Key has no linked user — status: no-user.

get_daily_brief

Generates the Daily Brief Clinical Terminal chat writes: a written brief on one day’s healthcare-vendor LinkedIn posts, shaped to your persona. Optionally framed for a conversation with one person, or narrowed to a topic. Each call is a fresh AI run, limited per key per day; for the brief already made this morning, use get_my_brief.

Ask it: “Write me a brief on yesterday's vendor news, focused on prior auth.”

Parameters
NameTypeDescription
date optionalstringAn Eastern-time day, YYYY-MM-DD. Defaults to today. The brief draws on that day’s 100 highest-priority posts.
person_id optionalnumberA person’s terminalId (from search_people or get_person). Frames the brief as preparation for talking to them.
focus_topic optionalstringNarrows the brief to a topic, e.g. “prior authorization”. 1–120 characters.
Example arguments
{
  "date": "2026-10-24",
  "focus_topic": "prior authorization"
}
Returns

One object.

statusok; no-posts (no LinkedIn posts that day); error (the write-up failed but the posts are real); budget (daily limit reached).
briefThe written brief. Machine-written from public posts.
subjectThe person the brief was framed for, when you passed person_id. Name only if they have no photo on file.
posts[] / upcomingEvents[]The posts it drew on, and upcoming events.
people[] / mentionedNames[]As in get_my_brief: people with a photo as name and terminalId; people without one by name only.
Errors and special responses
  • Daily limit reached — status: budget with the limit. It resets at midnight UTC.
  • Unknown person or bad argument — status: not_found or invalid_argument with a message saying which.

Providers

The buy side: US hospitals, health systems, FQHCs, rural health clinics, ASCs, imaging centers, physician groups, skilled nursing and home health.

get_provider_segments

Start any provider-market question here. Every segment with its entity count, its trailing-7-day signal volume, and the signed change against the week before. All segment keys come back, including the quiet ones, so you never have to guess whether a segment exists.

Ask it: “Which parts of the provider market moved this week?”

Parameters

None — call it with an empty arguments object.

Example arguments
{}
Returns

An array with one row per provider segment, zero-filled.

providerTypeSegment key — pass it to search_providers.
countProvider entities in the segment.
signals7d, signals7dPriorSignal rows in the last 7 days, and days 8–14.
deltaThe signed change between the two.
Errors and special responses
  • Reading signal counts — They count article-by-entity rows, not distinct articles, and are non-zero only for hospital and health-system segments.

search_providers

The provider counterpart to vendor search — by name, segment, state, health system or size. Names collide heavily in this data, so filter by state or size when you can.

Parameters
NameTypeDescription
query optionalstringProvider name or fragment; multi-word phrases work. 1–200 characters.
provider_type optionalenumA segment key from get_provider_segments, such as health_system, acute_care, critical_access, fqhc or asc.
state optionalstringA two-letter code or a full state name (“TX” or “Texas”).
health_sys_id optionalstringOnly members of one health system — a healthSysId from a result.
min_beds optionalintegerMinimum staffed beds, 1–5000. Drops providers with no bed count, such as clinics.
sort optionalenumsize (most beds first), name, or signal_recency (newest news first). Defaults to relevance with a query, name without.
limit optionalintegerMaximum results, 1–50. Default 20.
Example arguments
{
  "query": "Baylor Scott",
  "state": "TX",
  "sort": "size",
  "limit": 10
}
Returns

An array of providers.

id, terminalIdEither one works with get_provider.
name, city, stateIdentity and location.
providerSubtype, companyTypeSegment key, and the coarse type it derives from.
staffedBedsBed count, for hospitals and health systems.
healthSysIdThe parent health system, for a system-to-members lookup.
linkedinLinkedIn URL.
logoUrl, logoSourceThe provider’s logo, as on search_vendors: stored or scraped. Absent means no logo is stored yet, not that the provider has none.
lastSignalAtMost recent news detection, for hospitals and health systems.
Errors and special responses
  • Unrecognised state — Unknown state: "<state>". with the list of valid codes.

search_service_lines

Hospitals and health systems that run a clinical department — cardiology, oncology, neurology, orthopedics and 41 more — each with the evidence that says so: staff job titles naming the department, and sections of the provider’s own website. Use it instead of search_providers for any department question; that tool matches names only. This is a floor, not an inventory: a provider missing from the list may still run the department.

Ask it: “Which hospitals in Texas run a cardiology program?”

Parameters
NameTypeDescription
service_line requiredenumThe department key, such as cardiology, oncology, neurology, orthopedics, obgyn, behavioral, imaging or emergency.
state optionalstringA two-letter code or a full state name (“TX” or “Texas”).
cities optionalstring[]Only providers in these cities; needs state. A metro is several cities, so list the suburbs too, such as ["Houston", "Sugar Land", "The Woodlands"]. Case, “St” versus “Saint” and punctuation don’t matter.
level optionalenumhospital (individual facilities), system (health-system parents) or any. A system’s beds are its system-wide total. Default hospital.
provider_type optionalenumOne segment, such as acute_care, critical_access or childrens.
min_beds optionalintegerMinimum staffed beds, 1–5000. Drops providers with no bed count.
min_evidence optionalenumstrong keeps only a dedicated website section or 2+ staff titles; any also includes single mentions. Default any.
include_unclassified optionalbooleanReturn providers with no recorded segment, shown with a null providerType. Most are real hospitals and regional systems; a few are universities or payers, so check the name. false withholds and counts them. Default true.
limit optionalintegerMaximum providers, 1–50. Default 25.
Example arguments
{
  "service_line": "oncology",
  "state": "TX",
  "cities": [
    "Houston",
    "Sugar Land",
    "The Woodlands",
    "Katy"
  ],
  "limit": 25
}
Returns

One object: the line, the providers largest first, and counters that explain every provider not returned.

lineThe department key and its label.
results[].terminalId, openInGetProviderPass terminalId to get_provider as id when openInGetProvider is true. When it is false, the provider is not in the provider directory yet (mostly unclassified rows), so cite the row’s own evidence instead.
results[].name, city, state, providerType, isSystem, beds, websiteThe provider. beds is null when unknown.
results[].evidencestrength (strong or some), titles (headcount and up to 3 verbatim titles) and website (tier 1–3, pages, share of the site, up to 3 URLs).
providersWithLineEvery provider with evidence for the line.
droppedUnclassified, droppedByFilter, droppedNoCity, droppedNoCard, droppedBySizeWhy each provider read was not returned. droppedNoCity counts providers with no city on record, which a cities filter cannot match.
truncatedThe scan cap stopped the sweep. Narrow by state.
asOfWhen the nightly build last ran.
Errors and special responses
  • Unrecognised state — Unknown state: "<state>". with the list of valid codes.
  • cities without state — cities needs state — city names repeat across states, so pass both.
  • An empty list — No provider with evidence for the department matched. That means none recorded, not none exist — read the counters.

get_provider

One provider in depth: profile, health-system context including parent and largest members, technology relationships with verbatim evidence quotes, recent signals, and the clinical departments we hold evidence for. Each section says which kind of empty it is.

Parameters
NameTypeDescription
id requiredstringProvider id or terminalId from search_providers. A name is not an id.
Example arguments
{
  "id": "100245871"
}
Returns

One compact object, kept within a 20,000-character budget.

providerThe profile, as a search_providers row.
systemThe health system, its true member count, and up to 10 largest members. Omitted when the provider has no system.
edgesUp to 10 technology relationships, strongest evidence first.
signalsUp to 5 recent signals, one per source article.
serviceLinesClinical departments, strongest evidence first — each with its label, strength, staff title headcount and website tier. An absent department is unknown, not missing.
metaThe resolved provider, a coverageNote for non-hospital providers, and truncated listing anything trimmed.
Errors and special responses
  • Unknown id — Provider not found: "<id>". — search first; names are not ids.
  • A section is unavailable — { status: "unavailable", reason }: a source was down. Retry.
  • A section is not tracked — { status: "not_tracked_for_this_provider_type", reason }: relationships and signals are linked for hospitals and health systems only today, so for other providers this is unknown, not zero.

get_provider_metrics

Every CMS metric a traced hospital’s page shows, about a hundred across financials, operations, cost centers, quality, patient satisfaction and network, each with what the page keeps one click down: the period it covers (a cost-report fiscal year with its end date, or a discharge window), the release, CMS’s own measure name, the source, the page’s colour band and the related rows (a star rating, averages, an excess readmission ratio, counts). Read from the same record the page is written from, in the page’s order. Only traced hospitals answer; an untraced hospital says so instead of serving its unverified import.

Parameters
NameTypeDescription
id optionalstringProvider id or terminalId from search_providers or get_provider. A name is not an id. Required unless segment is given; omit it with a segment to compare every traced hospital.
groups optionalstring[]Only these groups: financial, operations, costCenters, quality, satisfaction, network. Default all six.
limit optionalnumberRows returned in the page’s order, default 40, max 120. A traced hospital’s page shows about 100; pass groups to choose which rows count. With a segment and no id: hospitals returned, default 25, max 50.
segment optionalstringA revenue-cycle market segment id from list_segments (for example revenue-cycle-prior-authorization or clinical-documentation-integrity): read the hospital as that segment’s vendor. The reading names the rows that segment’s buyer cares about, why, and what this hospital’s numbers mean, each with its period. Reads from a vendor’s seat, so a provider or investor reader beside it is refused.
reader optionalstringRead the rows as this reader instead of the session’s own: vendor:sales, vendor:product, provider:finance, provider:clinical, provider:operations, provider:* (anyone at the hospital, its executives included: one headline row per group in a neutral voice) or investor:*. Default: the session’s persona department on its employer side. A hospital department with no reader of its own reads as provider:*, and a department at a company that sells to hospitals as vendor:sales, with readerSource “default”; an unknown or independent employer, or a payor, agency, media, law or consulting employer with no matching department, gets rows only.
series optionalbooleanAttach each row’s year-by-year history, oldest first, as {year, value, period, band}. Default true; pass false for a smaller answer. A row with no traced history carries no series.
Example arguments
{
  "id": "686695",
  "groups": [
    "financial",
    "quality"
  ],
  "limit": 60,
  "reader": "vendor:sales"
}
Returns

One compact object within a 46,000-character budget.

providerterminalId, CCN and the page’s name.
datarunId and writtenAt of the record, and the cost report it reads: fiscal year, period end, CMS report number and status.
readingHow to read the rows as the session’s reader (persona department crossed with employer side) or the reader passed: readAs and frame set the posture, never lists the misreadings to avoid, priorities are that reader’s rows in order, each with a one-sentence soWhat computed from this hospital’s own values and bands, askNext the questions to put back, and bands what a tier means. readerSource says whether the reader came from the session, the side’s default or the reader argument. Absent only when the employer side is unknown.
metricsOne row per metric: group, key, label, value (the number), display (the page’s string, unit included), tier (green, yellow, red or null), on a rated row rule (the direction and the exact green, yellow and red boundaries the band came from), period, released, measure, source, sourceUrl and related. Compare on period, never on a year: fiscal years end on different dates per hospital. A row whose history is traced also carries series, every year oldest first; a null value is a year CMS did not report, never zero.
withheldGroups the key’s tier does not get, each with a reason. Never silent.
reading.segmentWith segment: the segment read for, its why, the segment’s priority rows each with period and soWhat, notReported (rows this hospital does not file, which are not zero) and, for a segment no CMS number measures, noCmsSignal instead of rows.
hospitalsWith segment and no id: every traced hospital, each with only the segment’s rows, ordered as meta.order says. meta.traced equals returned + unavailable + droppedByLimit + droppedByBudget; only traced hospitals are in it, so a ranking is a ranking of those, not of the market.
metatotalMetrics and byGroup before the limit, truncated naming anything cut, seriesRows and seriesDropped (series cut to fit, from the end, before any row), and timingsMs.
Errors and special responses
  • Unknown id — Provider not found: "<id>". — search first; names are not ids.
  • The hospital is not traced — { status: "not_traced", reason }: its page values are not yet checked against a public file, so none are served. get_provider still has its profile, system, vendors and news.
  • A health system or a non-hospital provider — { status: "not_tracked_for_this_provider_type", reason }: CMS files per hospital; call this on the system’s member hospitals.
  • The record is mid-refresh — { status: "unavailable", reason }: the rows and their parent are from different refreshes. Retry.

People

People with a current role at any hospital, health system, or published vendor, investor, payor or association, plus the alumni trail behind them.

get_persona

Research a role the way you would research a company. Real job titles with counts, how many people we track and at what kind of employer, duties quoted verbatim from real job postings, typical KPIs, buying role, and what people in the role say they care about — grounded in the census rather than in generic knowledge.

Ask it: “What does a CDI nurse actually do all day?”

Parameters
NameTypeDescription
query requiredstringA role in plain words (“CDI nurse”, “VP of revenue cycle”) or an exact personaId. 1–200 characters.
Example arguments
{
  "query": "VP of revenue cycle"
}
Returns

One object with status: "ok".

personaId, labelThe seniority-by-department group it resolved to.
roleDefinitionWhat the role is.
titleVariants[]Real job titles held, with counts.
censusHow many people we track, and at which employer types.
responsibilities[], kpis[], buyingRoleWhat the role does and is measured on.
jdQuotesQuotes from real job postings, fenced as untrusted text.
aggregatedWhat people in the role say they care about. Withheld below an anonymity floor, and note says why.
Errors and special responses
  • No match — status: "no_route" with personaMenu[]. Pick the closest personaId and call again.
  • More than one match — status: "ambiguous" with candidates[]. Call again with one of them; never guess.

search_people

Find people by name, employer or job title, everyone at one organization, or who runs it. People holding a leadership seat confirmed by our team or by the organization’s own leadership page come first, then everyone else by seniority. Every result holds a current role at a visible organization and lists the person’s other current roles. Pass at least one of query, organization_id, department or seat.

Ask it: “Who are the CEO, CFO and CNO at Albany Medical Center, and how do we know?”

Parameters
NameTypeDescription
query optionalstringMatched against name, employer and job title (and a confirmed seat’s title). 1–200 characters.
organization_id optionalstringOnly people currently at this organization. A numeric terminal id works too.
vendor_id optionalstringOlder name for organization_id. Pass one or the other.
department optionalenumOne of clinical, operations, general, finance, recruiting, customer_success, marketing, engineering, legal, data, product, sales, security, design, editorial, research.
role optionalenumSeniority: c_suite, vp, director, or executive for all three. Does not count as a filter on its own.
limit optionalintegerMaximum results, 1–50. Default 20.
seat optionalstringEnterprise. Only confirmed holders of one seat: ceo, president, coo, cfo, cmo_clinical, cno, cio, cmio, cmo_marketing, chro, cqo, or another key a result returned (such as clo_legal).
confirmed_only optionalbooleanEnterprise. Only people holding a confirmed leadership seat. Default false.
Example arguments
{
  "query": "Albany Medical",
  "role": "c_suite",
  "limit": 10
}
Returns

An array of people, one row per person: confirmed seat holders first, then the most senior role that matched.

idPerson id — pass it to get_person.
name, jobTitle, organizationWho, and the role shown: the matched confirmed seat, otherwise their most senior matching role.
seats[]Every confirmed seat the person holds: seatKey, title, chairTitle, tenure, organizationId, organization, confirmedBy (human = confirmed by our team, org_page = named on the organization’s own leadership page) and sourceUrl when recorded. tenure is permanent, interim or functional_head: the organization has no chief for that function and this person leads it at a lower rank, so title is their own title and chairTitle is the chair they occupy. Empty means none confirmed, not none held.
positionLevelSeniority: CEO, President, C_Suite, VP, Director, …
functionalDepartmentDepartment of that role.
personaId<level>_<department>, such as c_suite_ceo. An absent value means the role is unclassified, not junior.
imageUrl, linkedinPhoto and LinkedIn. A confirmed seat admits a person without a photo, so imageUrl can be absent. The profile headline is on get_person.
otherCurrentRoles[]Up to 5 other visible roles, most senior first.
otherCurrentRolesHiddenOther roles at employers we cannot name.
Errors and special responses
  • No filter — Provide at least one of query, organization_id, department, or seat.
  • organization_id and vendor_id disagree — An error asking for one of them.
  • organization_id is not an id — An error saying to pass an id or terminal id, not a name.
  • People held back — A second text block after the results counts people who matched but whose roles are at organizations not published here. Treat it as a coverage gap.
  • Nobody confirmed (seat or confirmed_only) — A second text block counts people who match in employment records but have no confirmed seat, and seat holders at organizations not published here. Treat it as a coverage gap, never as “nobody holds that role”.

get_person

One profile in full: confirmed seats, title, employer, other current roles, past roles, headline, headshot and LinkedIn. Every id from search_people and search_alumni resolves here.

Parameters
NameTypeDescription
id requiredstringPerson id from search_people or search_alumni, or a slug.
Example arguments
{
  "id": "Xk29fPq7LmN3"
}
Returns

One person object with the fields of a search_people row (seats[] is empty for a person with none; jobTitle is their most senior current role), plus:

pastRoles[]Up to 25 closed roles, newest departure first, with employer, title and dated start and end.
pastRolesWithheldPast employers we cannot name.
upcomingEventAppearancesUp to five upcoming conferences the subject appears at, with roles. Absent when none are recorded; from news and LinkedIn, so absence is not evidence.
Errors and special responses
  • Not found — Person not found. Also returned for a person with no confirmed seat and either no current role at a visible organization or no profile photo.

search_executives

Retiring: use search_people, which now lists an organization’s confirmed leaders first. This returns the same answer as search_people with confirmed_only and stays for one release so connected assistants keep working. Enterprise. Pass at least one of query, organization_id or seat.

Parameters
NameTypeDescription
query optionalstringMatched against name, the seat’s organization, the seat title and job title. 1–200 characters.
organization_id optionalstringOnly seats at this organization.
seat optionalstringOne seat by key, as in search_people.
limit optionalintegerMaximum results, 1–50. Default 20.
Example arguments
{
  "query": "Albany Medical",
  "limit": 10
}
Returns

The rows search_people returns with confirmed_only: true.

Errors and special responses
  • No filter — Provide at least one of query, organization_id, or seat.

search_alumni

The departures side of the graph. Anchor on a vendor, hospital, health system or any other published organization and get each person’s past role with a dated departure, plus every current role they hold, most senior first. Current employers are named when published and counted when not. Advisor, board and fractional seats are flagged, and when filters leave fewer than five people the closest misses come back too, each saying which filter it missed.

Ask it: “Who left Epic in the last year and where did they land?”

Parameters
NameTypeDescription
organization_id optionalstringAn organization id from search_vendors, search_providers or resolve_hospital, or its numeric slug. A name is not an id. Pass this or vendor_id; one of the two is needed.
vendor_id optionalstringDeprecated alias of organization_id, kept for existing callers.
left_after optionaldateYYYY-MM-DD. Only people who left on or after this date.
role optionalenumSeniority of the past role: c_suite, vp, director or executive.
department optionalstringDepartment of the past role, such as sales or engineering.
current_role optionalenumSeniority now, as a floor: director keeps people who are a director or more senior today, whatever they were before.
limit optionalintegerMaximum people, 1–50. Default 25.
Example arguments
{
  "organization_id": "100000001",
  "left_after": "2025-09-01",
  "role": "executive"
}
Returns

One object.

organizationThe anchor organization: id, name and type.
vendorDeprecated copy of organization (id and name), kept for existing callers.
results[]Newest departure first: the person, their pastRole at the organization with dates, and every currentRoles[] entry, with customer evidence for vendor employers.
totalMatchedEveryone with a past role at the organization, before filters.
_dropped* countersWhy matched people are missing, by reason.
Errors and special responses
  • No id passed — Pass organization_id — neither organization_id nor vendor_id was given.
  • Unknown or unpublished organization — Organization not found: "<id>". — pass an id from search_vendors, search_providers or resolve_hospital.
  • Undated departures — Excluded when left_after is set, and counted in the drop counters.

search_retirements

Executives who will retire or have retired, each with the last day, a confidence and who said so. Editor-confirmed retirements (a published story) come first; after them, people whose own LinkedIn profile says they have retired, marked low confidence. Every row is backed by a sourced claim, and the list grows as retirements are recorded.

Ask it: “Which health-system CEOs have announced they are retiring?”

Parameters
NameTypeDescription
status optionalenumannounced (last day still ahead), completed, or any. Default any.
seat optionalstringA seat such as ceo, cfo, cno or cio.
since optionaldateYYYY-MM-DD. Only last days on or after this date; rows with no last day are excluded.
min_confidence optionalenumhigh returns editor-confirmed retirements only; low or any also returns LinkedIn self-reports. Default any.
limit optionalintegerMaximum people, 1–50. Default 25.
Example arguments
{
  "status": "announced",
  "seat": "ceo"
}
Returns

One object.

results[]Announced first (soonest last day first), then completed, editor-confirmed before self-reported: the person, organization, seat, lastDay, status, confidence, the reporting source and every claims entry.
retirementsRecordedEvery retirement on record.
droppedByFilter, droppedNoPhoto, droppedBySizeWhy rows are missing; droppedBySize above zero means narrow the query or lower limit.
organizationHiddenPeople returned with the organization left blank because it is not published.
noteWhat the list does and does not cover.
Errors and special responses
  • Empty results — No matching retirements are recorded yet — not an error.

ask_leadership_editor

Hands a leadership question that needs several lookups to Lance Williams, Clinical Terminal’s AI leadership agent. It researches on its own with this server’s read-only tools plus a cited web search, and answers in prose with inline links and a sign-off line. Slower than one tool (up to about 90 seconds) and limited to a few questions per key per day; for a single fact, call search_people or get_person directly.

Ask it: “Who runs Atrium Health, and what changed in its C-suite this year?”

Parameters
NameTypeDescription
question requiredstringThe leadership question in plain words, 3–1,000 characters.
organization optionalstringOptional: the hospital, health system or vendor the question is about, by name.
Example arguments
{
  "question": "Who runs Atrium Health, and what changed in its C-suite this year?"
}
Returns

Prose text.

textThe answer with inline links, ending with the agent’s sign-off. Relay it as written; where it says something is not recorded yet, that is a coverage gap.
Errors and special responses
  • Paused or daily limit used — The agent says so; answer with search_people instead.

Signals

What the market did lately — news, funding, leadership changes.

search_signals

Recent market signals, newest first. Filter by text, by the entity a signal came from, by type, by source format, or by a detection window.

Ask it: “Show me every funding round in revenue cycle since May.”

Parameters
NameTypeDescription
query optionalstringMatched against title and summary. 1–200 characters.
entity_id optionalstringOnly signals about this entity.
origin_entity_type optionalenumvendor, provider (includes hospitals), hospital, investor or organization.
signal_type optionalstringAn exact, case-sensitive category such as Funding / Investment or Leadership Change.
source_type optionalenumThe source format, such as news_article, press_release, linkedin_post, sec_filing or job_posting.
detected_after optionaldateISO date or UTC datetime. On or after.
detected_before optionaldateISO date or UTC datetime. On or before; a bare date includes the whole day.
sort optionalenumimportance or recency. Accepted, but results currently always come back newest first. Default recency.
distinct_articles optionalbooleanOne row per article instead of one per article and linked entity. Default false.
limit optionalintegerMaximum rows, 1–50. Default 20.
Example arguments
{
  "signal_type": "Funding / Investment",
  "detected_after": "2026-05-01",
  "distinct_articles": true,
  "limit": 50
}
Returns

An array of signals, newest first.

id, articleIdRow id, and the article it came from — group on articleId to count stories.
title, summary, sourceUrlThe story.
detectedAtWhen we detected it.
topics[], categories[]What it is about. Prefer these to signalType.
originEntityId, originEntityTypeWhich entity the row is about.
linkedEntityCountHow many entities the article names.
urgency, painPoint, salesAngleMachine-written sales analysis.
Errors and special responses
  • Empty array — Nothing matched; there is no coverage note on this tool.

search_events

Published healthcare conferences and events: what is coming up, who is on an event’s roster (speaking, exhibiting, sponsoring, attending, hosting) and where a given person or organization is appearing. Events come from news and LinkedIn posts, not organiser registrations, and the list grows daily. An event with no roster means attendees are not recorded yet, never that nobody is going.

Ask it: “Which healthcare conferences are in Texas next quarter, and who is speaking?”

Parameters
NameTypeDescription
query optionalstringWords matched against the event title, host and location; all must appear.
starts_after optionaldateYYYY-MM-DD (Eastern time). Only events still running on or after this date. Default: today.
starts_before optionaldateYYYY-MM-DD. Only events starting on or before this date.
state optionalstringA US state as a 2-letter code or full name, e.g. TX or Texas.
city optionalstringA city name, e.g. Nashville.
format optionalenumin_person, virtual or webinar (a single online session).
entity_id optionalstringA person or organization: its terminalId, or the id from search_people, search_vendors, get_person or a roster row. Returns the events it appears at.
role optionalenumWith entity_id: speaking, exhibiting, sponsoring, attending or hosting.
limit optionalintegerMaximum events, 1–25. Default 10.
Example arguments
{
  "state": "Texas",
  "starts_before": "2027-01-31"
}
Returns

One object.

events[]Soonest first (or your territory’s states first, see orderedBy): title, dates, location, format, host, link and, when attendees are recorded, a roster. A person carries an id only when get_person will open it; an organization carries an id and a followUp tool only when we hold its profile. speakingDetails is copied as recorded and may be the speaker’s own title rather than the talk.
orderedBy, territoryStatesHow rows are sorted.
countersWhy events or ids are missing: filters, limit, response size, names without a profile.
coverageHow many upcoming events we hold, and how many have a roster.
snapshotBuiltAt, snapshotStaleWhen the event data was built; snapshotStale means it may be out of date.
Errors and special responses
  • Empty results — No matching event is recorded yet — not an error.
  • Unknown state or id — An error naming the bad state or entity_id.

Graph

Who runs what. This is the only place hospitals are addressable as an anchor.

resolve_hospital

Turn a hospital name into the id the relationship lookup accepts. Resolution only, not a profile — it returns ranked candidates so you can pick the right St. Mary’s before you ask about edges.

Parameters
NameTypeDescription
query requiredstringHospital name or part of one. 1–200 characters.
state optionalstringA two-letter state code. Full names are not accepted here.
limit optionalintegerMaximum candidates, 1–20. Default 10.
Example arguments
{
  "query": "Massachusetts General",
  "state": "MA",
  "limit": 5
}
Returns

An array of candidates, largest by staffed beds first.

terminalIdThe preferred get_relationships input.
idAlso accepted by get_relationships.
name, city, stateWhich hospital this is.
hospitalType, staffedBedsType and size, to tell same-named hospitals apart.
Errors and special responses
  • Empty array — No hospital matched.

get_relationships

Company-to-company edges touching an entity, with provenance: source, evidence quote, evidence tier, a citable article and when it was first seen. The anchor can be a vendor or a hospital, which is what makes “what does this hospital run” answerable.

Ask it: “What technology does Mass General run?”

Parameters
NameTypeDescription
entity_id requiredstringA vendor or hospital id, numeric slug or terminalId. Not a name.
edge_type optionalstringA relationship type such as CUSTOMER_OF or INVESTED_IN; case-insensitive.
limit optionalintegerMaximum edges, 1–200. Default 50.
Example arguments
{
  "entity_id": "100000001",
  "edge_type": "CUSTOMER_OF",
  "limit": 100
}
Returns

An array of edges, active first. When some were withheld it is instead { relationships, withheld, note }.

edgeType, relationshipLabelThe type to filter on, and its plain-English form.
labelThe organization on the other end.
sourceId, targetIdterminalIds of the two ends.
evidenceSnippet, evidenceTierThe supporting quote, and its strength: 1 case study, 2 customer list, 3 logo or passing mention.
evidenceNamesLabelWhether the quote actually names the other organization.
topArticleUrlAn article to cite.
firstSeenAt, lastConfirmedAtWhen the edge was first and last seen.
corroborated, corroborationQuoteIndependent corroboration, when checked.
Errors and special responses
  • Unknown id — Entity not found: "<id>". followed by how to pass an id: the id from search_vendors, a numeric slug, or a terminalId. A vendor name is not an id.
  • Withheld edges — Counted in withheld: the other organization is unpublished and cannot be named. Say “at least” when counting.

Publishing

Tools that write. Everything above is read-only; the brand-kit tools below also save, to your own account only.

publish_page

Publish a page your assistant composed — a market analysis, a vendor write-up, an article — as a hosted page on clinicalterminal.com, laid out like a Desk story: headline, byline row with the publish date, and a right rail showing the companies and people it is about. Unlisted by default: only someone with the link can read it. A public page gets a keyword URL, a sitemap listing and a Markdown twin for other agents.

Parameters
NameTypeDescription
title requiredstringPage title, 1–200 characters. Be specific.
body_html requiredstringThe page body only — what goes inside <body>, using the allowed tags and .ct-* classes. Up to 256 KB.
summary requiredstringOne sentence, up to 500 characters: the meta description and list subtitle.
citations optionalarrayUp to 50 { label, url } sources, rendered in the rail’s Sources block. Default [].
source_tools optionalstring[]Which tools on this server produced the data. Default [].
visibility optionalenumunlisted (unguessable link, not indexed) or public (indexable). Use public only when the user asks for a discoverable page. Default unlisted.
page_type optionalenumcomparison, analysis or article: the voice of the page and its default eyebrow. Every type uses the same layout. Guessed from the title when omitted.
artifact_id optionalstringOmit to create a page. Pass an existing id to update it in place at the same URL; visibility and page_type are then ignored.
entities optionalarrayUp to 12 { type, terminal_id } entries — company (hospitals included) or person — naming what the page is about, by the terminal ids the research tools returned. They render as the Who This Touches rail, with a leadership card for the first company. On an update, omit to keep the rail; send a list to replace it.
draft optionalbooleanRolling out: refused (nothing is published) until drafts are switched on for your account. true saves a private draft instead of publishing. Nobody else can see it; you read it at the returned preview_url and click Publish there, choosing link-only or public and whether to show your name. visibility is ignored on a draft.
base_revision optionalintegerRolling out, with draft. On an update: the revision your assistant last read (get_my_page) or saved. If the page changed since, the save is refused instead of overwriting edits it has not seen.
charts optionalarrayUp to 4 charts drawn into the page, the same forms send_to_desk takes: a vendor chart { key, kind: "vendor", vendor_tid, chart } (leader_origins, hired_from, departures, department_mix, seniority, capital_raised or customer_map; vendor_tid from search_vendors) or a hospital line chart. Place each with a paragraph that is exactly <p>[chart:key]</p>; it becomes a picture of the chart with its source note and a small table of its numbers. If any chart cannot be drawn, nothing is published and the reply says why.
chart_preview optionalbooleantrue returns each chart’s headline and state, a line chart’s values by year, or the reason it cannot be drawn, and publishes nothing. Call it first, then write the page from those numbers.
Example arguments
{
  "title": "Texas acute-care hospitals: Q3 news activity",
  "summary": "Twelve Texas systems drove most provider news this quarter.",
  "body_html": "<h1>Texas acute-care activity</h1><p>Baylor Scott and White led signal volume.</p>",
  "page_type": "analysis"
}
Returns

One object.

urlThe page URL — give it to the user exactly as returned.
artifact_idFor later updates or revocation.
visibilitypublic or unlisted.
published_at, byte_sizeWhen, and how large.
entities_droppedTerminal ids from entities that are not on the rail (no match, or past the 12 cap). The publish still succeeds.
markdown_urlPublic pages only: the agent-readable twin.
revision, noteOn an update: the revision number and a note that readers see it within a minute.
status, preview_urlDrafts: status: "draft", the revision and the private preview_url where you read and publish it. A draft has no public url until you publish it.
Errors and special responses
  • Rejected HTML — Sending <!doctype>, <html>, <head>, <body>, <style>, <script> or <link>, an inline style or id, an event handler, or an image from an unapproved host is rejected with an error naming each offender. Nothing is silently stripped.
  • Too large — body_html over 262,144 bytes. Cut sections rather than truncating.
  • Daily quota — 20 publishes per key per UTC day, updates included, shared with publish_comparison.
  • Storage quota — 200 live pages per key. Revoking one frees a slot.
  • Update of an unknown id — No live page with that artifact_id is published under this account.
  • Stale revision — The page changed since base_revision (it may have been published): read it again with get_my_page and reapply the edit.
  • Drafts not enabled — A draft request while drafts are switched off: nothing is saved.

get_my_page

Rolling out: available once drafts are switched on for your account. Reads back one of your pages (a draft, or a live page) so an edit starts from the current text, not a stale copy.

Parameters
NameTypeDescription
artifact_id requiredstringThe id publish_page returned, or one from list_my_comparisons.
offset optionalintegerByte offset of the body part to return. Long pages come in 40 KB parts: pass the previous reply’s next_offset until it is null. Default 0.
revision optionalintegerRequired for a later part: the revision the first part returned. If the page changed between parts, the read is refused so two versions are never joined; read it again from offset 0.
Example arguments
{
  "artifact_id": "AbC123xyz"
}
Returns

One object.

title, summary, citationsThe page as saved.
status, revisiondraft or live, and the revision to pass as base_revision when saving the edit.
preview_url, urlWhere you preview it; the public URL once live.
body_html, offset, next_offset, total_bytesThis part of the body and where the next part starts (null on the last part).
Errors and special responses
  • Unknown or unreadable id — No page with that id under this account, or it was revoked.
  • Page changed between parts — The page was saved after your first part: discard the parts you have and read it again from offset 0.

publish_comparison

The same mechanics, shape and quota as publish_page, with guidance tuned for a vendor comparison, and page_type defaulting to comparison. A comparison assembled in a chat window dies in the scrollback; this is the version you can send to someone.

Parameters
NameTypeDescription
title requiredstringPage title, 1–200 characters — “Waystar vs Adonis — denials, 400-bed IDN” beats “Vendor Comparison”.
body_html requiredstringThe page body only. Same allowed tags and .ct-* classes as publish_page.
summary requiredstringOne sentence, up to 500 characters.
citations optionalarrayUp to 50 { label, url } sources. Default [].
source_tools optionalstring[]Which tools produced the data, such as get_vendor_dossier. Default [].
visibility optionalenumunlisted or public. Default unlisted.
page_type optionalenumcomparison, analysis or article. Default comparison.
artifact_id optionalstringPass an existing id to update in place.
entities optionalarrayThe companies and people the comparison covers, as { type, terminal_id }, up to 12 — the Who This Touches rail.
Example arguments
{
  "title": "Waystar vs Adonis: denials, 400-bed IDN",
  "summary": "Waystar has broader confirmed hospital traction; Adonis is newer with regional references.",
  "body_html": "<h1>Waystar vs Adonis</h1><p>Waystar leads on confirmed customers.</p>",
  "citations": [
    {
      "label": "Waystar case study",
      "url": "https://www.waystar.com/case-studies/"
    }
  ],
  "source_tools": [
    "get_vendor_dossier",
    "get_relationships"
  ]
}
Returns

The same object as publish_page.

Errors and special responses
  • Every publish_page error — Applies here too, against the same shared quota.

list_my_comparisons

Everything published under your key, newest first. This is your exposure audit — the one place to check what of yours is publicly readable.

Parameters
NameTypeDescription
limit optionalintegerHow many to return, 1–50. Default 20.
include_revoked optionalbooleanInclude revoked pages, flagged. Set false for live pages only. Default true.
Example arguments
{
  "limit": 10,
  "include_revoked": false
}
Returns

{ ok: true, artifacts }, newest first.

artifact_id, title, summaryWhich page.
urlThe page URL; dead once revoked.
visibilitypublic (indexable) or unlisted (link only).
revokedTrue once taken down.
published_at, byte_sizeWhen, and how large.
view_count_approxApproximate page loads — not analytics.

revoke_comparison

Take a published page offline. The body is deleted rather than hidden and the URL stops working within about a minute. Permanent: republishing produces a new URL. Works for pages from either publish tool.

Parameters
NameTypeDescription
artifact_id requiredstringThe id a publish tool or list_my_comparisons returned.
Example arguments
{
  "artifact_id": "waystar-vs-adonis-denials-k3f9x2"
}
Returns

{ ok: true, artifact_id }. One stored-page slot is freed.

Errors and special responses
  • Unknown, not yours, or already revoked — The same answer for all three, so ids cannot be probed.

Brand kit

Clinical Terminal's own press kit, as data, and your own brand kits for any company: make one from the company's website, confirm it, and your designs come out in that brand.

get_brand_kit

The same kit that lives at clinicalterminal.com/pressrelease, returned as data. An assistant that calls it first uses the real marks; one that does not tends to invent a red. You can also keep your OWN brand kit for any company here: make one from the company’s website, then ask for it with company, and the designs come out in that brand with a “Data: Clinical Terminal” credit. Kits are private to the person who made them.

Ask it: “Design a LinkedIn banner in Clinical Terminal's brand”

Parameters
NameTypeDescription
company optionalstringLeave it out for the Clinical Terminal kit (unchanged). Any company’s name, id or terminalId returns your confirmed kit for it. Without one you get the Clinical Terminal kit plus a vendorKit.unavailable reason.
format optionalstringjson (the default) or design_md: your kit as a DESIGN.md to save in your project.
Example arguments
{}
Returns

One object.

assets[]Every logo, wordmark, avatar, banner and cover: absolute url, kind, format, theme, pixel size and transparency.
colors[]The brand colors as hex, each with its role.
fonts[]The typefaces, their roles and where to get them.
usage, principles[]Do and don’t rules, and one-line brand rules.
readMeHow to read the payload. Quote values exactly.

create_brand_kit

Reads the company’s own website and saves a DRAFT kit: colors with a ground picked from the site, Google fonts, light and dark logos, corner radius and voice. It fixes what extraction gets wrong (the company name, button-text contrast, a logo-gradient highlight, accent contrast, a dark-ground logo, fonts not on Google Fonts) and lists each fix. The kit is private to you; re-running makes a new draft and never touches a confirmed kit. A free account can make 5 a month.

Ask it: “Make a brand kit for SmarterDx”

Parameters
NameTypeDescription
company requiredstringAny company: its name, id (from search_vendors) or terminalId.
url optionalstringStaff only: read this page instead of the website on the company’s record.
Example arguments
{
  "company": "SmarterDx"
}
Returns

One object.

draft, draftIdThe draft kit and the id to confirm.
fixes[]Each fix as a before → after line to show the person.
nextThe preview-then-confirm steps for the assistant to follow.

confirm_brand_kit

Confirms your latest draft for a company, with any edits, so get_brand_kit serves it. Edits are checked: a 6-digit hex, button text at least 4.5:1 on the primary, a font on Google Fonts, a radius from 0 to 64 px. A rejection names the field. An older draft is refused.

Ask it: “Confirm it, but make the primary #00C8E2”

Parameters
NameTypeDescription
draft_id requiredstringThe draftId from create_brand_kit.
company requiredstringThe same company you passed to create_brand_kit.
edits optionalobjectChanges to apply, e.g. { colors: { primary: '#00C8E2' } }: colors, fonts, radius and voice.
Example arguments
{
  "draft_id": "a1b2c3d4e5",
  "company": "SmarterDx",
  "edits": {
    "colors": {
      "primary": "#00C8E2"
    }
  }
}
Returns

One object.

kitThe confirmed kit.
nextWrite DESIGN.md into the project and add it to CLAUDE.md.

withdraw_brand_kit

Withdraws your confirmed kit for a company, so get_brand_kit stops serving it. It is archived with your reason, and never affects anyone else’s kit.

Ask it: “Withdraw my SmarterDx brand kit”

Parameters
NameTypeDescription
reason requiredstringWhy, in your words.
company requiredstringThe company: its name, id or terminalId.
Example arguments
{
  "reason": "We rebranded",
  "company": "SmarterDx"
}
Returns

One object.

withdrawnTrue when a confirmed kit was withdrawn.

get_infographic_agent

The brief an assistant follows to turn Clinical Terminal research into a social story: a carousel of static frames, or a motion story you can download as MP4 or GIF. It covers which tools to research with, how numbers must be sourced, the logo rule, a storyboard you approve before anything is built, and how to build each style.

Ask it: “Make me a carousel on Abridge's momentum this month”

Parameters
NameTypeDescription
style optionalstringcarousel (the default) or motion-story. Leave it out and the assistant asks.
topic optionalstringWhat the story is about. Leave it out and the assistant asks. Up to 500 characters.
vendor optionalstringA company’s name: brand the story in your confirmed kit for that company instead of Clinical Terminal’s.
Example arguments
{
  "style": "carousel",
  "topic": "Abridge momentum this month"
}
Returns

Plain text.

the briefStep-by-step instructions for the assistant. It does not research or build anything itself; the assistant then calls the other tools.

Moonlight

Talk to your own Moonlight agent, the opportunity scout that emails you postings that fit your brief. Reads explain; writes change only your own brief and feedback.

set_moonlight_brief

Tells Moonlight, Clinical Terminal’s opportunity scout, what extra work or job you want. Moonlight then emails you postings that fit, on the cadence you choose. Two steps, never one: the first call reads your words and saves nothing; the second, after you confirm what it read, commits the brief and switches the emails on.

Ask it: “Have Moonlight look for clinical UX contract work for me, about 10 hours a week, remote.”

Parameters
NameTypeDescription
text optionalstringStep 1: what you want, in your own words (up to 2,000 characters).
token optionalstringStep 2: the token step 1 returned, once you have confirmed the targets. Expires after 15 minutes and works once.
cadence optionalstringStep 2: daily, weekly (default) or strong_only (only when something fits strongly).
Example arguments
{
  "text": "Clinical UX contract work, ~10 hrs/week, remote. Ambient AI vendors."
}
Returns

One object.

ok / result.statusStep 1: proposed with targets (craft, departments, engagementTypes, hoursPerWeek, geo, domains, seniority, exclusions, compFloor), missing andtoken; or parse_failed with one question to ask you. Step 2: confirmed with the brief’s version and cadence.
Errors and special responses
  • Proposal expired or already used — status: expired, invalid_token or no_proposal: start again from step 1.
  • No Landscape subscription — ok: false, reason: not_entitled.

get_moonlight

Your Moonlight setup in one call: the brief (its text, chips and version), whether the emails are on and how often, the last nightly run and what it found, where mail goes (masked) and anything that would stop it, and how many cards were sent and still need your feedback.

Ask it: “Why haven't I heard from Moonlight?”

Parameters

None — call it with an empty arguments object.

Example arguments
{}
Returns

A short text answer, then one object.

brieftext, targets, version, cadence; null before your first brief.
emails / lastRun / cardsOn or off, cadence, masked address and blockedReason; the last run’s date and result; cards sent and awaiting feedback.
Errors and special responses
  • No Landscape subscription — reason: not_entitled.

explain_moonlight_matches

What Moonlight would send today for your saved brief, as a funnel: postings close to the brief, then recent, in your roles, (contract, for a contract-only brief), a close enough fit, and still open on the job board. When nothing would send, it names the step that emptied the list and the chip that would widen it. With try_edits it shows the funnel before and after those changes and saves nothing. Checks live job boards, so it takes a few seconds; limited to 40 calls per key per day.

Ask it: “Would taking full-time roles too get me more matches? Don't change anything yet.”

Parameters
NameTypeDescription
try_edits optionalarrayHypothetical chip edits, each {op, group, value}: op is add or remove; group is craft, departments, engagementTypes, hoursPerWeek, geo, domains, seniority, exclusions or compFloor. Not saved.
cadence optionalstringHypothetical daily, weekly or strong_only.
Example arguments
{
  "try_edits": [
    {
      "op": "add",
      "group": "engagementTypes",
      "value": "full_time"
    }
  ]
}
Returns

A short text answer, then one object.

preview, or before / afterstages (each step and how many postings are left), cards, sample (company and role) and bottleneck; with try_edits, both funnels plus the brief version to pass to edit_moonlight_brief.
Errors and special responses
  • No brief yet — reason: no_brief: write one with set_moonlight_brief.
  • A value that cannot go in that group — reason: invalid_argument, naming the edit.
  • Daily limit reached — The message says when it resets.

list_moonlight_cards

The opportunity cards Moonlight has emailed you, newest first: company, role, sent date, why it fit, the posting link and your feedback so far, each with the card_id give_moonlight_feedback needs.

Ask it: “What did Moonlight send me last week?”

Parameters
NameTypeDescription
limit optionalnumberCards per page, 1 to 20. Default 10.
cursor optionalstringThe nextCursor from the previous page.
awaiting_feedback optionalbooleanOnly cards you have not reacted to.
Example arguments
{
  "awaiting_feedback": true,
  "limit": 5
}
Returns

A short text answer, then one object.

rowscardId, companyName, title, sentAt, fitLine, jobUrl, outcome.
nextCursor / scanned / awaitingFeedbackPaging, and counts over your newest 200 cards (capped says when there are older ones).
Errors and special responses
  • No Landscape subscription — reason: not_entitled.

edit_moonlight_brief

Changes your saved brief straight away: add or remove chips (all apply or none do), set the cadence, or turn the emails off and on. Chip edits carry the brief version you last read, so a stale or repeated call is refused instead of applied twice. Returns the saved brief and today’s funnel. To rewrite the brief from scratch, use set_moonlight_brief.

Ask it: “OK, add full-time to my Moonlight brief, and only email me weekly.”

Parameters
NameTypeDescription
edits optionalarrayChip changes, each {op, group, value}, same groups as explain_moonlight_matches.
expected_version optionalnumberThe brief version you last read (get_moonlight). Required with edits.
cadence optionalstringdaily, weekly or strong_only.
emails optionalstringon or off. The brief is kept either way.
Example arguments
{
  "edits": [
    {
      "op": "add",
      "group": "engagementTypes",
      "value": "full_time"
    }
  ],
  "expected_version": 3,
  "cadence": "weekly"
}
Returns

A short text answer, then one object.

statusapplied or unchanged, with the new version, targets, cadence, emailsEnabled and preview (the funnel after a chip edit).
Errors and special responses
  • The brief changed since you read it — reason: version_mismatch with the current version. Nothing was saved.
  • A bad value, or an edit that empties the brief — reason: invalid_argument. Nothing was saved.
  • No brief yet — reason: no_brief.

give_moonlight_feedback

Records your reaction to one card: interested, not_for_me, already_talked, mute_company (never this company again) or not_this_role (never this job title again). The last two add an exclusion chip to your brief. The first answer on a card is the one kept.

Ask it: “Not for me, and never send me Experian again.”

Parameters
NameTypeDescription
card_id requiredstringFrom list_moonlight_cards.
action requiredstringYour reaction, one of the five above.
Example arguments
{
  "card_id": "job_3f2a9c1d0b7e4a65",
  "action": "mute_company"
}
Returns

A short text answer, then one object.

statusapplied or outcome_already_set, with the outcome and any excluded value written to the brief.
Errors and special responses
  • Unknown card — reason: not_found.

Analysis

Ad-hoc SQL across the warehouse. These two are staff-only; every other tool on this page does not.

describe_schema

The column inventory for an allowed dataset, so an assistant can author correct SQL instead of guessing at table shapes.

Parameters
NameTypeDescription
dataset optionalenumknowledge_graph, clinical_ai_design or analytics. Default knowledge_graph.
table optionalstringRestrict to one table.
Example arguments
{
  "dataset": "knowledge_graph",
  "table": "providers"
}
Returns

{ dataset, columns }, ordered by table then column position.

columns[]Each column’s table name, column name and data type.
Errors and special responses
  • Any failure — Never an error response: columns comes back empty with an error field. An unknown table returns an empty list with no error.

run_analysis_sql

A read-only query for analysis the fixed tools cannot express. One statement, writes rejected, a LIMIT 1000 added when you give none, and capped at 5 GiB scanned.

Parameters
NameTypeDescription
sql requiredstringOne SELECT or WITH query against the allowed datasets.
params optionalobjectNamed parameters, referenced as @name in the SQL.
Example arguments
{
  "sql": "SELECT provider_subtype, COUNT(*) AS n FROM `clinical-ai-design.knowledge_graph.providers` WHERE state = @st GROUP BY 1 ORDER BY n DESC",
  "params": {
    "st": "TX"
  }
}
Returns

{ ok, rows, bytesProcessed }.

Errors and special responses
  • Any rejection — Never an error response: ok: false with an error naming the rule — multiple statements, anything but SELECT/WITH, a write keyword anywhere in the text, a dataset or project outside the allowlist, or a scan estimated over 5 GiB.

Limits & errors

These apply to every tool, before it runs. Tool-specific errors are listed on each entry above.

CodeWhat it means
401No authorization header was sent.
403Invalid or revoked key, a lapsed Landscape subscription, or over the monthly quota. The response says which.
429Per-minute rate limit. Retry after the interval the response names.

The monthly cap is the control that actually binds. The per-minute limit is counted per server instance and the service scales out, so treat the stamped number as a floor rather than a promise.