Skip to main content

MCP tools

The hosted MCP server offers operations of the OpenAPI document as tools, one tool per operation. Connecting, entitlements, and charges are in use with AI assistants (MCP).

Tool names​

Each tool is named by its operation's operationId (get_security_quote, get_series_observations, list_news, run_agentic_research, …) and carries the operation's own description and parameters.

Operations offered as tools​

operationsoffered as tools
data reads, including digests, theses, themes, and the shared daily research reportyes
GET /v1/account, GET /v1/account/usage, and GET /v1/auth/tiersyes
POST /v1/research/agentic/analyze (a research run)yes, as run_agentic_research
listing research runs, a run's status, cancel, and the stored reportyes
deleting a stored reportno
the copilot and model inferenceno
the session archiveno
GET /v1/auth/whoamino
service statusno

Every tool​

The tools in the order the server lists them, with the operation each calls and the entitlement it needs (entitlements); every key can call a tool marked —.

tooloperationentitlementread-only
get_accountGET /v1/account—yes
get_account_usageGET /v1/account/usage—yes
list_tiersGET /v1/auth/tiers—yes
get_crypto_assetGET /v1/crypto/assets/{asset}datayes
get_crypto_historyGET /v1/crypto/pairs/{pair}/historydatayes
get_crypto_quoteGET /v1/crypto/pairs/{pair}/quotedatayes
get_datasetGET /v1/datasets/{dataset_id}datayes
get_instrumentGET /v1/instruments/{key}datayes
get_taxonomyGET /v1/taxonomydatayes
list_datasetsGET /v1/datasetsdatayes
list_instrumentsGET /v1/instrumentsdatayes
get_futures_familyGET /v1/futures/{root}datayes
get_futures_historyGET /v1/futures/{root}/continuous/historydatayes
get_futures_positioningGET /v1/futures/{root}/positioningdatayes
get_futures_quoteGET /v1/futures/{root}/continuous/quotedatayes
get_futures_technicalsGET /v1/futures/{root}/continuous/technicalsdatayes
get_fx_historyGET /v1/fx/{pair}/historydatayes
get_fx_quoteGET /v1/fx/{pair}/quotedatayes
get_fx_reference_ratesGET /v1/fx/{pair}/reference-ratesdatayes
get_central_bank_ratesGET /v1/markets/rates/central-bank-ratesdatayes
get_commodity_agricultureGET /v1/markets/commodity/agriculturedatayes
get_commodity_benchmarksGET /v1/markets/commodity/benchmarksdatayes
get_commodity_energyGET /v1/markets/commodity/energydatayes
get_commodity_livestockGET /v1/markets/commodity/livestockdatayes
get_commodity_metalsGET /v1/markets/commodity/metalsdatayes
get_commodity_supply_demandGET /v1/markets/commodity/{root}/supply-demanddatayes
get_credit_spreadsGET /v1/markets/credit/spreadsdatayes
get_cross_assetGET /v1/markets/cross-assetdatayes
get_crypto_market_assetsGET /v1/markets/crypto/assetsdatayes
get_crypto_market_globalGET /v1/markets/crypto/globaldatayes
get_equity_indicesGET /v1/markets/equity/indicesdatayes
get_equity_moversGET /v1/markets/equity/moversdatayes
get_equity_sector_rotationGET /v1/markets/equity/sectors/rotationdatayes
get_equity_sectorsGET /v1/markets/equity/sectorsdatayes
get_equity_summaryGET /v1/markets/equity/summarydatayes
get_fixed_income_etfsGET /v1/markets/fixed-income/etfsdatayes
get_fx_pairsGET /v1/markets/fx/pairsdatayes
get_macro_snapshotGET /v1/markets/macro/snapshotdatayes
get_rate_market_indicatorsGET /v1/markets/rates/market-indicatorsdatayes
get_tips_breakevensGET /v1/markets/rates/tips-breakevensdatayes
get_yield_curveGET /v1/markets/rates/yield-curvedatayes
get_yield_historyGET /v1/markets/rates/yield-historydatayes
get_news_articleGET /v1/news/{article_id}datayes
list_newsGET /v1/newsdatayes
search_newsGET /v1/news/searchdatayes
get_quotesPOST /v1/quotesdatayes
get_digestGET /v1/digests/{ref}datayes
get_market_digestGET /v1/digests/marketdatayes
get_security_researchGET /v1/securities/{symbol}/researchdatayes
list_themesGET /v1/themesdatayes
list_thesesGET /v1/thesesdatayes
run_agentic_researchPOST /v1/research/agentic/analyzeaino
cancel_research_runPOST /v1/research/runs/{run_id}/cancelaino
list_research_runsGET /v1/research/runsaiyes
retrieve_research_reportGET /v1/research/runs/{run_id}/reportaiyes
retrieve_research_runGET /v1/research/runs/{run_id}aiyes
get_security_analystGET /v1/securities/{symbol}/analystdatayes
get_security_calendarGET /v1/securities/{symbol}/calendardatayes
get_security_digestGET /v1/securities/{symbol}/digestdatayes
get_security_financialsGET /v1/securities/{symbol}/financialsdatayes
get_security_historyGET /v1/securities/{symbol}/historydatayes
get_security_profileGET /v1/securities/{symbol}/profiledatayes
get_security_quoteGET /v1/securities/{symbol}/quotedatayes
get_security_technicalsGET /v1/securities/{symbol}/technicalsdatayes
get_security_thesisGET /v1/securities/{symbol}/thesisdatayes
list_exchangesGET /v1/securities/exchangesdatayes
list_industriesGET /v1/securities/industriesdatayes
list_industry_groupsGET /v1/securities/industry-groupsdatayes
list_sectorsGET /v1/securities/sectorsdatayes
list_security_corporate_actionsGET /v1/securities/{symbol}/corporate-actionsdatayes
list_security_eventsGET /v1/securities/{symbol}/eventsdatayes
list_security_filingsGET /v1/securities/{symbol}/filingsdatayes
list_security_insider_transactionsGET /v1/securities/{symbol}/insider-transactionsdatayes
list_security_institutional_holdersGET /v1/securities/{symbol}/institutional-holdersdatayes
list_sub_industriesGET /v1/securities/sub-industriesdatayes
get_seriesGET /v1/series/{key}datayes
get_series_historyGET /v1/series/{key}/historydatayes
get_series_observationsGET /v1/series/{key}/observationsdatayes
get_series_projectionsGET /v1/series/{key}/projectionsdatayes
get_series_technicalsGET /v1/series/{key}/technicalsdatayes
get_vix_term_structureGET /v1/series/vix-term-structuredatayes
list_seriesGET /v1/seriesdatayes

The research tool​

run_agentic_research uses your AI pool (charges for AI work). It returns one result with content, events, completion, and complete. A run that did not complete comes back as an error result; treat its content as partial. A finished call's settled usage is in completion.usage.

The call's first progress message names the run (run: run_…). Use that id to read the run with retrieve_research_run, stop it with cancel_research_run, and read its stored report with retrieve_research_report, including after a dropped call; list_research_runs finds a run you no longer have the id for.

Your MCP client's cancellation also stops the call; it is charged like a canceled research run and returns no usage, so read it with retrieve_research_run.