Sugra API MCP
OfficialUse the Sugra API through MCP for catalog discovery, direct endpoint calls, one-step data fetching, response shaping, and entity/sanctions screening.
Search the bundled endpoint catalog by natural language, with optional toolset/source filters.
List catalog toolsets and source families to understand available data coverage.
Describe an endpoint by
operation_idto get parameters, request body schema, and agent hints (duration, concurrency, bulk cost).Call any cataloged Sugra API operation with query/path params and optional JSON body.
Shape
call_endpointandfetch_dataresults withlimit,fields, andinclude_raw.Fetch data in one step with
fetch_datausing a natural-language query; it picks the best endpoint and returns missing-param guidance if needed.Screen a person or organization against sanctions/watchlists with
sugra_entity_screen.Resolve an entity by LEI or VAT and get a compact KYB envelope with screening and optional ownership/adverse-media slices via
sugra_entity_lookup.Catalog tools work without an API key; data-calling tools need a Sugra API key or OAuth token with
sugra:read.
Integrates Google Gemini with Sugra API for retrieving market prices, macro indicators, and entity screening data.
Supports JetBrains IDEs (via Gemini Code Assist) to use Sugra API tools for financial data and entity lookup within the development environment.
Allows OpenAI GPT models to fetch market data, screen entities, and access financial endpoints via Sugra API.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Sugra API MCPWhat is the current price of Apple stock?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
sugra-api-mcp
Give any AI agent access to 1,600+ data endpoints across markets, economics, companies, government, news, climate, maritime and entity screening - through one MCP server.
Works with ChatGPT, Claude, Gemini, xAI, Cursor, VS Code and any MCP client.
Official Model Context Protocol server for the Sugra API: one connector, a bundled endpoint catalog, and structured tool results with source attribution on every answer.
See it in action
An agent answering a real question end to end - resolving entities, pulling live snapshots and history, and citing the source and freshness on every number:

More examples:
Macro research - one prompt builds a full G7 inflation and policy-rate table, each cell dated and sourced, with the unavailable ones flagged rather than faked:

Cross-domain snapshot - Brent crude, marine weather and regional risk pulled together for a shipping desk, each with its source and timestamp:

Related MCP server: BlockRun MCP
What a session looks like
Hosted MCP transcript (the three composed tools shown here run on the hosted endpoint). Captured example - wording and figures vary by run and as new BLS data is published:
User: Where does US inflation stand, and how has it trended over the past year?
resolve_entity("US inflation")
-> macro indicator cpi_us (U.S. Bureau of Labor Statistics)
get_snapshot("cpi_us")
-> latest reading with freshness, provenance and quota cost
get_timeseries("cpi_us", metric="macro_series", range="1y")
-> 12 monthly points with an explicit downsampling flag
Agent: US CPI printed 2.9% year over year in the latest release, down from
3.5% twelve months earlier - a steady decline since spring.
Source: U.S. Bureau of Labor Statistics via the Sugra API.Every tool result carries structured metadata - source attribution, freshness, and rate-limit cost - so agents can cite sources and budget requests instead of guessing.
How it works
flowchart LR
A["AI agent<br/>(ChatGPT, Claude, Gemini, xAI, IDEs)"] --> B["Sugra MCP<br/>gateway tools, plus agent tools when hosted"]
B --> C["Sugra API<br/>1,600+ endpoints, 36 data domains"]
C --> D["160+ primary sources<br/>markets, economics, government,<br/>news, climate, maritime"]Behind the gateway sits the Sugra API: 160+ primary sources - sovereign statistics agencies, central banks, intergovernmental bodies and more - feeding 1,600+ endpoints across 36 data domains. The server ships a bundled catalog of the full endpoint surface, so discovery (search, describe, toolsets) runs locally without network calls; only actual data requests hit the API.
What agents build with it
The Sugra API skills live in Sugra-Systems/sugra-api-skills. The server serves five of them as MCP resources (sugra://skills/...) from a pinned commit of that repository: resources/read the URI after connect.
Agent skills
These skills teach the catalog loop. They do not add MCP tools. Connect the Sugra MCP server separately (hosted or local). The plugin package for each agent lives in Sugra-Systems/sugra-api-plugins.
Claude Code
/plugin marketplace add Sugra-Systems/sugra-api-plugins
/plugin install sugra-api@sugra-api-pluginsSkills appear as /sugra-api:<skill>, for example /sugra-api:discover-and-call.
Codex
codex plugin marketplace add Sugra-Systems/sugra-api-plugins
codex plugin add sugra-api@sugra-api-pluginsGrok
grok plugin install Sugra-Systems/sugra-api-plugins#xaiCursor, Gemini CLI and other agents
npx skills add https://mcp.sugra.aiOr copy the skill folders of sugra-api-skills into the agent's skills directory.
ChatGPT
The skills install from OpenAI's Plugins Directory. The MCP server attaches as a hosted connector at https://mcp.sugra.ai/mcp (permanent alias https://app.sugra.ai/mcp).
Six workflow prompts ship with the server and turn these into one-click flows in clients that surface MCP prompts:
Market and macro research - "Compare inflation and central bank policy rates across the G7." (
macro_briefing)Equity snapshots with sources - "Where does NVIDIA stand today - price, profile, and market backdrop?" (
market_snapshot)Sanctions and compliance screening - "Screen this supplier and resolve its LEI identity." (
sanctions_screening)Sector comparison - "Energy versus technology: valuations and flows side by side." (
sector_compare)Climate, maritime and trade intelligence - "Red Sea shipping this week: chokepoint transits, crude price, and weather on the route." (
earth_conditionsplus the transport and commodities catalog)Source discovery - "What does the catalog offer for fixed income, and from which institutions?" (
source_overview)
Every answer carries source attribution and freshness metadata, so agents cite instead of guessing.
Hosted MCP (recommended)
No install. In Claude, ChatGPT and Codex, add the Sugra API MCP server from a directory:
Claude (web, desktop, mobile, Claude Code and Cowork): Add to Claude opens the Sugra API MCP server in Anthropic's Connectors Directory; connect it and sign in with your Sugra account. In claude.ai the directory is under Customize > Connectors. Claude Code signed in with a claude.ai account picks the connector up automatically;
/mcplists it.ChatGPT and Codex: Add to ChatGPT opens the Sugra API MCP server in the OpenAI Plugins Directory.
Any other MCP client, or a manual setup, points at the hosted Streamable HTTP endpoint:
https://mcp.sugra.ai/mcpThe gateway tools plus the composed agent tools
resolve_entity,get_snapshotandget_timeseriesOAuth sign-in through the Claude and ChatGPT connector flows, or
Authorization: Bearer sugra_xxx_...with an API keyAs a custom connector in claude.ai: Customize -> Connectors -> Add custom connector
In ChatGPT: Settings -> Connectors -> Add MCP server
Already added Sugra to Claude as a custom connector? That connection keeps working and shows under "Custom". Connecting the Sugra API MCP server from the directory as well gives you two connections, so remove the custom one first, then connect from the directory.
Local package
Runs on your machine over stdio (or self-hosted HTTP) with an API key:
pip install sugra-api-mcpEight gateway tools
stdio for desktop clients and IDEs, Streamable HTTP for self-hosting
Authenticates with
SUGRA_API_KEY
Get a free API key at app.sugra.ai/register (Free tier: 50 req/day).
Quick start
pip install sugra-api-mcp
export SUGRA_API_KEY=sugra_xxx_... # free key: app.sugra.ai/register
sugra-api-mcp call quotes_symbol_price --params '{"symbol":"AAPL"}'The same call through an agent: connect the server to your client (next section) and ask "What is AAPL trading at? Use Sugra." The agent finds quotes_symbol_price in the catalog and calls it with the symbol.
Connect your client
Supported clients:
Anthropic Claude: Claude Desktop, Claude Code (CLI), claude.ai (web)
OpenAI GPT: ChatGPT (via MCP connector)
Google Gemini: Gemini CLI, Gemini Code Assist (VS Code + JetBrains)
xAI: Remote MCP Tools in xAI SDK and Responses API
IDEs: VS Code (native), Cursor, Zed, Cline, Continue.dev, Windsurf
Custom agents: anything built on the Python or TypeScript MCP SDK
Claude Desktop (stdio)
Add to claude_desktop_config.json:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.jsonLinux: Claude Desktop has no Linux build. On Linux,
pip install sugra-api-mcpand use Claude Code (CLI), an IDE client, or the hosted HTTP endpoint below.
{
"mcpServers": {
"sugra": {
"command": "sugra-api-mcp",
"env": {
"SUGRA_API_KEY": "sugra_xxx_yourkey..."
}
}
}
}Restart Claude Desktop. Sugra tools appear in the tools menu.
Claude Code (Anthropic CLI)
Signed in to Claude Code with a claude.ai account? Add to Claude connects the Sugra API MCP server from the Connectors Directory in claude.ai, and it appears in /mcp without any local install. To run the local package instead:
claude mcp add sugra -- sugra-api-mcp
# then set the env var that sugra-api-mcp reads
export SUGRA_API_KEY=sugra_xxx_...Or edit ~/.claude/config.json manually with the same shape as Claude Desktop above.
To install the skills as a plugin (separate from the MCP server):
/plugin marketplace add Sugra-Systems/sugra-api-plugins
/plugin install sugra-api@sugra-api-pluginsUsage with Gemini CLI
Gemini CLI reads MCP servers from ~/.gemini/settings.json (user scope) or
.gemini/settings.json in the project. For a local stdio install, add:
{
"mcpServers": {
"sugra": {
"command": "sugra-api-mcp",
"env": {
"SUGRA_API_KEY": "sugra_xxx_yourkey..."
}
}
}
}If the console script is not on PATH, use "command": "python" with
"args": ["-m", "sugra_api_mcp"] instead. The equivalent Gemini CLI command
is:
gemini mcp add --scope user -e SUGRA_API_KEY=sugra_xxx_yourkey... sugra sugra-api-mcpOr connect to the hosted endpoint without installing the package:
gemini mcp add --scope user --transport http \
--header "Authorization: Bearer sugra_xxx_yourkey..." \
sugra https://mcp.sugra.ai/mcpRun gemini mcp list to check the connection, then enter /mcp in an
interactive session to inspect the available tools. A local stdio connection
shows the eight gateway tools in Tool reference; the hosted
endpoint also shows the three hosted-only agent tools.
If a local server does not connect from a new directory, review and trust that
workspace with gemini trust before retrying.
These examples were checked against the Gemini CLI MCP documentation and Gemini CLI v0.51.0.
Cursor, Zed, Cline, Continue.dev, Windsurf
Each of these has an MCP settings file (typically mcp.json or equivalent) with the same stdio config shape as Claude Desktop.
ChatGPT
Add to ChatGPT installs the Sugra API MCP server from the OpenAI Plugins Directory. Or add the hosted HTTP endpoint (below) as an MCP connector, since ChatGPT does not launch local stdio processes.
HTTP (claude.ai, ChatGPT, remote agents)
In claude.ai, Add to Claude connects the Sugra API MCP server from Anthropic's Connectors Directory; in ChatGPT, Add to ChatGPT installs it from the OpenAI Plugins Directory. For a manual setup or any other Streamable HTTP MCP client, use the hosted endpoint:
https://mcp.sugra.ai/mcpAuthenticate with OAuth in the connector flow or with Authorization: Bearer sugra_xxx_....
As a custom connector in claude.ai: Customize -> Connectors -> Add custom connector. In ChatGPT: Settings -> Connectors -> Add MCP server.
Tool reference
The local package exposes eight gateway tools. The hosted endpoint adds three composed analysis tools on top (see Hosted MCP above). The package exposes exactly eight tools:
Tool | Purpose |
| One-step: find best endpoint for a natural-language query and call it. Combines search + call in one round trip. |
| Search the bundled endpoint catalog. Runtime search does not fetch |
| Inspect an endpoint by |
| Call a Sugra API operation by |
| List catalog groups with endpoint counts and descriptions. |
| Show bundled catalog source metadata. |
| Screen a name against sanctions and watchlists (Sugra Entity). |
| Composed entity lookup by identifier - |
call_endpoint and fetch_data both support response shaping with limit, fields, and include_raw. Shaping works on enveloped ({"data": ...}) and envelope-less payloads alike; fields entries may use dotted paths into nested objects (geo.city), and meta.shaped reports what was actually applied (fields_applied / fields_unmatched, limit_applied, records_path, order, kept_end) rather than echoing the request. limit and fields work on the records list: the envelope data list, a bare top-level array, or the one list inside an object data when exactly one of data, entries, events, history, items, observations, points, records, results, rows, series, timeseries holds a list (for example data.items on the latest news, data.observations on a FRED series). When data has no such single list but every one of its values is an object holding exactly one list named observations, as with several named sub-series side by side, limit bounds each data.<key>.observations list on its own; fields there still names keys of data. Keys beside that list, such as total and count, stay as sent, and lists nested inside records are never truncated. A fields entry that names a key of data itself projects that object instead, and a projection that matches nothing leaves the payload whole. meta.shaped.limit_applied says whether the bound took effect, and meta.shaped.records_path names the list used (data, data.<key>, data.*.observations, or null when no records list was used). limit keeps the newest end of the records list when every record carries one date or period key (such as date, period or year) in one format and the list runs one way by it: the last N records of an oldest-first list, in their order, or the first N of a newest-first list. Otherwise it keeps the first N records. Whenever a limit bounds a records list, meta.shaped.order says asc, desc or unknown and meta.shaped.kept_end says newest or first, each as a map by sub-series name for sibling sub-series. A top-level JSON array (or scalar) is always wrapped as {"data": ...} so the MCP result stays an object; otherwise FastMCP output validation reports the successful call as an error and drops the rows.
fields takes at most 32 paths, each at most 256 characters and 16 dotted parts; past any of these the call answers projection_too_large before any request is made. With fields, one projection also visits at most 100,000 list items, runs for at most 5 seconds, and takes a response of at most 2,000,000 characters of JSON before projection. That bound sits far above the 18,000-character limit on the result, which applies after projection: a 16-day weather forecast is about 295,000 characters before fields=["daily"] cuts it to fit. None of these bounds applies without fields. Shaping runs on its own pool of two worker threads, never on the event loop: at most 8 jobs run or wait for a worker, 4 of them for one caller, and a call that finds no free slot within 2 seconds answers server_busy with scope shaping or caller_shaping.
describe_endpoint returns computed agent_hints per endpoint so agents can budget time and parallelism before calling:
duration_class-fast(under ~2s, snapshot-backed),slow(live upstream proxying, occasionally 15s+), orheavy(per-item upstream work, large batches can exceed the gateway timeout)max_concurrency- advisory ceiling for parallel calls from one sessionbulk_cost- on per-item bulk endpoints: 1 request credit per item in the request body (the API reports the total in theX-RateLimit-Costresponse header)
Hosted-only agent tools (mcp.sugra.ai/mcp)
The hosted MCP endpoint at https://mcp.sugra.ai/mcp serves the same eight tools PLUS three composed agent tools that are not available on stdio or self-hosted installs:
Tool | Purpose |
| Free text (ticker, company, indicator, coin, currency pair) to a canonical market or macro entity. Ambiguous matches return ranked candidates, never a silent pick. |
| Entity plus a named recipe to one composed current view with freshness, provenance, coverage, and billing blocks. Composed calls charge a fixed recipe cost (1-2 requests) from the daily quota. |
| Entity plus metric ( |
These three tools wrap an internal composed plane that requires an infrastructure credential available only on the hosted deployment. The tool code ships inside the package, but it is registered only by the hosted HTTP entry point and only when that credential is present - pip install sugra-api-mcp (stdio and self-hosted HTTP) always exposes the classic eight-tool gateway. Hosted-only examples in any documentation are labeled as such. For compliance entity lookups (LEI / VAT, sanctions screening) use sugra_entity_lookup and sugra_entity_screen, which work on every transport.
CLI
Server startup is unchanged:
sugra-api-mcp
sugra-api-mcp --transport streamable-http --port 8001Catalog and gateway helpers:
sugra-api-mcp doctor
sugra-api-mcp list-toolsets
sugra-api-mcp search "NASDAQ futures"
sugra-api-mcp describe cot_financial
sugra-api-mcp call quotes_symbol_price --params '{"symbol":"AAPL"}'Environment variables
User-facing configuration for local installs, MCP clients, Docker stdio, and directory sandboxes (for example Glama Try in Browser). Set only this:
Variable | Required | Default | Description |
| For API calls | - | Your Sugra API key ( |
Optional overrides (leave unset unless you need them):
Variable | Default | Description |
|
| Override the Sugra API base URL (self-hosted or beta API only). |
|
| Downstream HTTP timeout in seconds for calls from this server to the Sugra API. |
Operator-only settings for self-hosted Streamable HTTP (reverse proxy CORS/hosts,
OAuth authorization-server wiring, and shared secrets) are documented in
docs/self-hosting.md. Do not put operator secrets into
public directory sandboxes. SUGRA_MCP_TRUST_PROXY_HEADERS (off by default)
makes the server read X-Real-IP and X-Forwarded-Host; set it only behind a
reverse proxy that overwrites both on every request, and never where clients
can reach the process directly (details in the same guide).
SUGRA_MCP_LIMITS (off by default) turns on request limits counted in the
server's own memory; the same guide lists its settings.
HTTP transport with OAuth
When running with --transport streamable-http the server allows unauthenticated MCP discovery requests (initialize, notifications/initialized, tools/list, resources/list, prompts/list, and ping) so ChatGPT Apps and other mixed-auth clients can discover tool metadata. Tool calls still require Authorization: Bearer .... Two token formats are accepted:
Raw API key (
sugra_...) - passed through as the downstreamx-api-key. Compatible with earlier local API-key setups.OAuth JWT - signature verified against the issuer's JWKS. The audience must match
https://app.sugra.ai/mcp, the token must includesugra:read, and hosted access is validated against APP before resolving the user's primary API key. Successful hosted OAuth requests update MCP connection activity in APP.
Most users should use the hosted endpoint https://mcp.sugra.ai/mcp with an API
key as Bearer instead of self-hosting OAuth; standalone OAuth clients sign in at
the alias https://app.sugra.ai/mcp for now. If you run your own HTTP process, see
docs/self-hosting.md.
Timeouts and the error contract
SUGRA_TIMEOUT caps each downstream HTTP call from this server to the Sugra API (default 30 seconds). It is one link in a longer chain; when a tool call fails, elapsed_ms in the error payload tells you which link cut it:
MCP client (agent harness) own tool timeout, often 60-180s, client-controlled
-> hosted proxy (app.sugra.ai) 86400s, effectively unlimited
-> this server (httpx) SUGRA_TIMEOUT, default 30s
-> Sugra API -> upstreams 15-60s per upstream call, server-sideTool failures return structured JSON instead of raising, so agents can pick a retry strategy:
| Meaning | Retry strategy |
| No response within | Retry once: the aborted attempt usually completes server-side and warms upstream caches. Then narrow the request (smaller batch, tighter filters). |
| Could not reach the Sugra API (DNS failure, connection refused) | Retry after a short delay. |
| Connection dropped mid-request | Retry once. |
free-text string + | The API answered with HTTP 4xx/5xx; | Honor |
| Unexpected failure inside the gateway ( | Report if persistent. |
| A | Shorten the query to the instrument, series, place or task. |
| A | Name fewer or shorter fields, add |
| A concurrency limit was reached. | Retry after a few seconds. |
All error payloads carry elapsed_ms. url is present on transport and HTTP errors (not on tool_execution_failed, which can fire before a URL exists). On the three transport errors status_code is null (no HTTP status was received) - consumers comparing status_code numerically should guard for that. If a tool call instead fails with a bare client-side message and no structured JSON, the timeout fired in your agent harness above this server: raise the client's tool timeout, not SUGRA_TIMEOUT.
Examples
Ask Claude:
"Search Sugra endpoints for NASDAQ futures."
"Describe the
cot_financialoperation.""Call
quotes_symbol_pricewith symbol AAPL and return only symbol and price.""List available Sugra toolsets."
Troubleshooting
Looking for get_market_price, get_macro_indicator, or get_news? Those curated tool names appear in some older directory listings and never shipped in this package - use fetch_data for one-step natural-language calls or search_endpoints plus call_endpoint for explicit routing.
missing_api_key in tool responses
The server starts and lists its tools without a key, but API-calling tools (call_endpoint, fetch_data, the entity tools) return {"error": "missing_api_key"} until the server can find one. Depending on how you run it:
As an MCP tool from your client (Claude, ChatGPT, Gemini, xAI, IDE, etc.): check the
envblock in your MCP config file. Value should be a full key likesugra_ao1_..., not empty and not wrapped in extra quotes.Shell / CI:
export SUGRA_API_KEY=sugra_...before runningsugra-api-mcp.HTTP mode: set via
.envor systemdEnvironmentFile, not the shell.
sugra-api-mcp doctor reports whether the key is visible to the process.
401 Unauthorized or 403 Forbidden in tool responses
Key accepted but rejected. Common causes:
Key was regenerated in app.sugra.ai/developer/keys and your config still has the old one.
Typo - key contains only lowercase letters and digits, no spaces, no trailing newlines.
Free tier was deactivated. Sign in to verify status.
429 Too Many Requests
Hit your plan's daily limit. Response headers include X-RateLimit-Reset with the UTC timestamp when the counter resets (midnight UTC). Over MCP the tool result carries reason: daily_limit_reached, status_code: 429, retry_after, and daily_limit and plan when the API named them. Plans: sugra.systems/api/pricing.
Before the limit is reached, a call_endpoint or fetch_data result shows what is left: meta.quota holds limit, remaining (requests left today) and resets_at, copied from the API's X-RateLimit-* response headers. A result carries no meta.quota when the API did not report a quota.
Invalid Host header (only if self-hosting HTTP mode)
FastMCP has DNS rebinding protection for public hostnames behind a reverse proxy. See docs/self-hosting.md for the allowed-hosts setting.
Tool result truncated with meta.truncated notice
Some endpoints return very large payloads (long price histories, hourly forecasts, full catalogs). A result is capped at 18,000 characters of JSON with ASCII escapes, so a CJK or accented character counts as its six-character escape and non-ASCII text is counted generously. Clients limit what they pass to the model in their own ways: Claude Code writes a tool result over 50,000 characters to a file instead of handing it to the model, and Codex limits a tool result by tokens, with a budget the user sets, and cuts the middle out beyond it. Every shape we measured at 18,000 characters, the densest included, stayed within Codex's default budget; a denser result, or a lower budget set in the client, can still be trimmed by the client. The cap is the same for every client. A larger result is cut to fit, whatever its shape: the lists at most two levels under data (data, data.<key>, data.<key>.<key>, whatever the key is called) are measured record by record, a big list is cut before small ones beside it, and a cut list keeps at least one record. A list keeps the newest end by the same order rule as limit, else its first records; through call_endpoint, a forecast or calendar keeps its records from today onward instead, oldest-first or newest-first alike, with kept_end nearest. fetch_data runs its operation through call_endpoint and is cut the same way, its meta.fetch_data (written when the response's meta is an object or absent) counted within the cap. The cut runs on the shaping pool, never on the event loop, so a full pool answers server_busy; it has a 5-second clock, read between records, and past it the result is refused; the fixed tools stop waiting for a cut half a second after that clock, and call_endpoint half a second after two such clocks, as its fields projection has its own; both then answer response_too_large, and a cut that cannot start within the pool's 2-second wait answers server_busy. The fixed tools gate an error body like any other result; an error payload over the cap that call_endpoint passes on as it came is refused without being measured. meta.truncated says what was cut: reason (exceeds_response_size_cap), path of the largest list cut with its original_count, kept_count, order and kept_end, the sizes original_chars, kept_chars and cap_chars, a lists entry per path (with kept_range, the first and last date kept) when several lists were cut, and a retry_hint that names what was kept and only the parameters the operation has. A forecast of up to about two weeks keeps the hours from today and its whole daily list, and the hint offers fields=["daily"] or a smaller params.forecast_days; a 16-day forecast can lose its last days as well, and its hint then offers only a smaller params.forecast_days, although fields=["daily"] returns all 16 days within the cap; a quote history keeps its newest bars, and the hint offers params.limit or a narrower params.start to params.end. When no cut fits, the result is a response_too_large error whose message gives the size and the limit in characters and names the large part: a record that is larger than the limit by itself, a record that does not fit beside the rest of the response and the cut notice (with both sizes, and how many other lists hold such a record), the one record each list keeps when only together they do not fit (with their sum and the largest of them), or the part outside the lists that is too large, and when it can, the fields that leave the large part out. The refusal itself always fits the cap: when it would not, it keeps only the size line and a URL cut to 300 characters.
Python version 3.11 or higher is required
sugra-api-mcp requires Python 3.11+. Check: python --version. If you have 3.10 or older:
Ubuntu: install Python 3.11 or newer from your distribution packages or the deadsnakes PPA.
macOS:
brew install python@3.11Windows: download from python.org
Then recreate your venv.
Hosted mcp.sugra.ai/mcp returns 5xx
The hosted endpoint can briefly restart after deploys. Wait 60 seconds and retry. If persistent, email support@sugra.systems.
Debugging tool calls locally
Run with stdio and log JSON-RPC messages:
SUGRA_API_KEY=sugra_... sugra-api-mcp 2>&1 | tee mcp-debug.logSend manual JSON-RPC from a second terminal using nc or an MCP inspector.
Development
git clone https://github.com/Sugra-Systems/sugra-api-mcp
cd sugra-api-mcp
pip install -e ".[dev,http]"
export SUGRA_API_KEY=sugra_...
python -m sugra_api_mcp # stdio mode
python -m sugra_api_mcp --transport streamable-http --port 8001 # HTTP mode
python scripts/build_endpoint_catalog.py # rebuild bundled catalog from sibling API openapi.json
python scripts/build_endpoint_catalog.py --source https://sugra.ai/openapi.json # from the live spec
# On DRIFT, catalog-parity.yml opens or updates PR branch ci/catalog-resync.Run tests:
pytestDocker
Build the image from the repository root:
docker build -t sugra-api-mcp .Run in stdio mode (the default entrypoint) for MCP clients that spawn a local process:
docker run -i --rm -e SUGRA_API_KEY=sugra_... sugra-api-mcpRun the Streamable HTTP transport on port 8001 with Docker Compose:
export SUGRA_API_KEY=sugra_...
docker compose up -dThen point your MCP client at http://localhost:8001/mcp. The compose service
passes SUGRA_API_KEY and the optional overrides (SUGRA_API_BASE,
SUGRA_TIMEOUT) from your shell when set, and checks container health against
http://localhost:8001/health. Reverse-proxy and OAuth operator settings are
documented in docs/self-hosting.md.
Every response the application sends, errors included, carries the header
Server: sugra-api-mcp. So does uvicorn's own 400 for a request it cannot
parse under the httptools parser, which the http extra installs and uvicorn
picks by default; under the h11 parser that 400 goes out without the header.
Set SUGRA_MCP_SERVER_VERSION=1 (or true, yes, on) in the server's
environment to add the package version to that header
(sugra-api-mcp/<version>) and to the /health response, which leaves the
version out otherwise.
A note on auth: no environment variable is baked into the image and none is
required for the container to start. In HTTP mode clients authenticate per
request with Authorization: Bearer sugra_..., so SUGRA_API_KEY on the
container is only a fallback for requests without a Bearer token.
License
MIT © 2026 Sugra Systems, Inc.
Available Tools
8 toolscall_endpointARead-onlyIdempotentInspect
Call a Sugra API endpoint by operation_id from the bundled catalog.
Plan calls with describe_endpoint's agent_hints: duration_class "fast" usually responds in under ~2s, "slow" usually 1-5s and occasionally 15s+ on a cold upstream, "heavy" can exceed the gateway timeout - keep parallel calls within max_concurrency and prefer small batches. Bulk endpoints bill 1 request credit per body item. Failures return structured errors {error, reason, status_code, elapsed_ms, retry_hint}; after "upstream_timeout" a single retry often succeeds because the aborted attempt warms upstream caches.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON request body for a POST operation, matching the request_body_schema returned by describe_endpoint(operation_id): a JSON object for most operations, or a JSON array when that schema's top-level type is array. Omit for GET operations. | |
| limit | No | Bounds ONLY the top-level list: the envelope data list (or a bare top-level array). Nested lists inside records are never truncated; meta.shaped reports whether the limit applied. | |
| fields | No | Optional projection of keys to keep on each record. Dotted paths (geo.city) walk nested objects. meta.shaped reports fields_applied and fields_unmatched. Omit to keep every key. | |
| params | No | Query and path parameters for this operation_id. Keys and types are operation-specific - call describe_endpoint(operation_id) first to get the exact parameter names, types, and examples. Omit if the operation takes none. | |
| include_raw | No | If true, attach the original unshaped payload under raw when it fits the size cap; otherwise meta.raw_omitted explains why. Default false. | |
| operation_id | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral context such as response times per duration_class, bulk billing, and error structures, which exceeds the annotations. Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description enriches with performance and error details but doesn't constrain further.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured, starting with the core purpose and then providing operational guidance in a logical flow. It is dense with useful information but remains focused; each sentence contributes to understanding performance, billing, and error handling.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity with six parameters and nuance like duration_class and bulk billing, the description covers performance expectations, error handling, and retry strategy. However, it doesn't elaborate on the output schema, but since an output schema exists, additional explanation is not necessary.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 83%, with detailed descriptions in the schema for body, limit, fields, and params. The description does not add significant new meaning beyond what the schema already provides, but it does mention the operation_id and its role in retrieving schemas. Baseline 3 is appropriate given the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool calls a Sugra API endpoint by operation_id from a bundled catalog, which is specific and distinguishes it from siblings like search_endpoints or describe_endpoint. The verb 'call' and resource 'endpoint' are precise.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides detailed guidance on when to use this tool, including how to plan calls using describe_endpoint's agent_hints and the importance of referring to describe_endpoint for parameters. It doesn't explicitly state when NOT to use it, but the guidance is clear enough about preconditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
describe_endpointARead-onlyIdempotentInspect
Describe one Sugra API endpoint by operation_id.
Includes agent_hints (duration_class fast/slow/heavy, max_concurrency,
bulk billing) so you can budget timeouts and parallelism before calling.
POST endpoints with a JSON body also carry request_body_schema (the
resolved JSON schema) - construct the body argument from it instead
of guessing key names. Call this after search_endpoints and before
call_endpoint when you need the exact parameter names and examples.
| Name | Required | Description | Default |
|---|---|---|---|
| operation_id | Yes | Catalog operation_id from search_endpoints (or from list_toolsets drill-down). Unknown ids return error unknown_operation_id. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds genuine behavioral value: it discloses that the response includes agent_hints (duration_class, max_concurrency, bulk billing) and that POST endpoints carry request_body_schema, which instructs the agent how to construct the body argument. This goes beyond the structured annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is tightly structured: purpose first, then valuable behavioral hints, then workflow guidance. Every sentence earns its place, and there is no filler or repetition of the tool's title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple single-parameter, read-only tool with a rich output schema, the description covers everything needed to call it correctly: what it does, what the response contains, how to obtain operation_id, and where it fits in the workflow. The output schema covers return-value details, so nothing important is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for the single parameter operation_id, and the schema already explains its provenance and error behavior. The description does not add much new parameter-level meaning beyond mentioning that exact parameter names come from this tool, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Describe one Sugra API endpoint by operation_id.' It is clearly differentiated from siblings by placing it in a workflow between search_endpoints and call_endpoint, so an agent can tell it apart from search, call, and data-fetch tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use it: 'Call this after search_endpoints and before call_endpoint when you need the exact parameter names and examples.' This provides both temporal sequencing and a decision condition, making the usage context unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
fetch_dataARead-onlyIdempotentInspect
One-step fetch: find the best Sugra endpoint for the query and call it.
Combines search_endpoints + call_endpoint into a single round trip. Use this when you want data without manually picking an operation_id. The full search_endpoints + describe_endpoint + call_endpoint dance is still available when you need explicit control, but for most natural-language queries this tool is enough.
Behavior:
Search the bundled catalog for the query. Top match wins.
If the matched endpoint has required parameters and they are all provided in
params, call it and return the response.If required parameters are missing, return the candidate endpoints and the missing-params list so the LLM can retry with the correct
paramsdict on the next call.
Examples:
fetch_data("US CPI inflation", params={"series_id": "CPIAUCSL"})→ calls /api/v1/fred/series/CPIAUCSL, returns observations.fetch_data("Bitcoin price", params={"coin_id": "bitcoin"})→ calls /api/v1/crypto/bitcoin/price.fetch_data("Latest financial news")→ news_latest has no required params, returns latest news directly.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON body for an auto-selected POST operation; the tool returns the request_body_schema to fill when the match needs one. Pass a JSON object or a JSON array as that schema's top-level type dictates. | |
| limit | No | Bounds ONLY the top-level list: the envelope data list (or a bare top-level array). Nested lists inside records are never truncated; meta.shaped reports whether the limit applied. | |
| query | Yes | Natural-language request for data (examples: 'US CPI', 'Bitcoin price', 'latest news'). The tool picks the top catalog match and calls it. If required params are missing it returns needs_params instead of guessing. | |
| fields | No | Optional projection of keys to keep on each record. Dotted paths (geo.city) walk nested objects. meta.shaped reports fields_applied and fields_unmatched. Omit to keep every key. | |
| params | No | Parameters for the auto-selected endpoint. If omitted and the best-match endpoint has required parameters, the tool returns that endpoint's required_parameters and examples so you can retry with them filled in. | |
| include_raw | No | If true, attach the original unshaped payload under raw when it fits the size cap; otherwise meta.raw_omitted explains why. Default false. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), so the bar is lower; the description still adds real value by disclosing the step-by-step behavior (top match wins, missing required params returns candidates + missing-params list for retry) and showing concrete call examples. It doesn't describe rate limits or exact response envelopes, but the output schema covers the return shape. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average but every section earns its place: purpose line, usage routing, numbered behavior list, and three concrete examples. It is front-loaded with the core purpose. Only mild redundancy (the params/body retry behavior appears in both the numbered list and the schema descriptions) keeps it from a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Complete for a moderately complex tool (6 params, 1 required, output schema present). The output schema explains return values, so the description need not. It covers selection behavior, retry contract, usage boundaries vs siblings, and example invocations. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all six parameters in detail, including the limit scoping rule, fields projection with dotted paths, and include_raw semantics. The description adds marginal value by showing params usage in examples, but does not go beyond what the schema states. Baseline 3 is correct.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('find the best Sugra endpoint for the query and call it') and explicitly names the siblings it combines (search_endpoints + call_endpoint). An agent can immediately distinguish this one-shot convenience tool from the manual three-step dance. This is well above the vague 'fetch data' baseline.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use ('without manually picking an operation_id', 'most natural-language queries') and when-not-to-use (when you need explicit control, the search_endpoints + describe_endpoint + call_endpoint dance is still available). Names the alternative tools directly. Nothing is left to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_sourcesARead-onlyIdempotentInspect
List source families in the bundled catalog with endpoint counts.
Use the family names as the source filter on search_endpoints. This does not call the Sugra API.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds non-obvious behavioral context by stating 'This does not call the Sugra API,' indicating a local, low-cost operation beyond what the annotations convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three short sentences with no filler. It front-loads the core purpose, then gives a practical usage hint, then a clarifying behavioral note. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple: zero parameters, an output schema is present, and annotations cover safety and idempotency. The description adds the only missing context (localiveness and how to use the result), making it complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the baseline is 4. The description doesn't attempt to explain parameters because none exist; instead it focuses on the meaning of the returned family names, which is relevant downstream.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'List source families in the bundled catalog with endpoint counts.' It clearly distinguishes this from siblings like search_endpoints or list_toolsets by naming the exact object being listed and the data returned.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides actionable guidance: 'Use the family names as the source filter on search_endpoints.' It also clarifies that this tool does not call the Sugra API, indicating when it is appropriate for local/bundled data. It gives clear context but doesn't spell out explicit exclusion scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_toolsetsARead-onlyIdempotentInspect
List catalog groups with endpoint counts and short descriptions.
Use the group names as the toolset filter on search_endpoints. This does not call the Sugra API; it reads the bundled catalog.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already provide readOnlyHint, openWorldHint, idempotentHint, and destructiveHint, so the description adds value by stating that this reads the bundled catalog and does not call the Sugra API. That is a meaningful behavioral fact not encoded in structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three short sentences with no filler. It front-loads the core purpose, then adds the use-the-result guidance, then a useful offline behavior note. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters, existing annotations, and an output schema, the description tells an agent everything it needs to call the tool correctly and what to do with the results. There is no missing prerequisite, filtering instruction, or safety concern.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has zero parameters, so the baseline is 4. The description adds some return-shape context (endpoint counts and short descriptions), which is sufficient for a parameterless listing tool.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('List catalog groups') and the output shape ('with endpoint counts and short descriptions'). It clearly distinguishes this from search_endpoints by describing the output as a filtering input for that tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly describes the intended downstream use: 'Use the group names as the toolset filter on search_endpoints.' It also clarifies that this reads the bundled catalog and does not call the Sugra API, which gives clear context. It does not explicitly name when-not-to-use or list alternatives, so it earns a 4 rather than a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_endpointsARead-onlyIdempotentInspect
Search the bundled Sugra endpoint catalog by natural-language query.
Use this to pick an operation_id. It does not fetch data. Typical loop:
search_endpoints(query) -> ranked hits with required_parameters
describe_endpoint(operation_id) -> params, request_body_schema, agent_hints
call_endpoint(operation_id, params=..., body=...) or fetch_data(query, params=...)
Filter with toolset or source only after list_toolsets / list_sources; a misspelled filter is an error, not a silent empty result.
Examples:
search_endpoints("US CPI inflation")
search_endpoints("AAPL price", toolset="markets")
search_endpoints("container ship AIS", toolset="network")
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum ranked hits to return. Default 10. Does not call the Sugra API; this only bounds the catalog search list. | |
| query | Yes | Natural-language search over the bundled catalog. Name the instrument, series, place, or task (examples: 'US CPI', 'AAPL quote', 'North Sea AIS'). Returns ranked operation_id hits with required_parameters. Then call describe_endpoint on a hit before call_endpoint. | |
| source | No | Optional source-family filter as listed by list_sources (macro, markets, ...). An unknown value returns error unknown_source with known_sources. | |
| toolset | No | Optional catalog group filter (markets, macro, news, network, ...). Call list_toolsets for the live names. An unknown value returns error unknown_toolset with known_toolsets rather than an empty hit list. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the tool read-only, idempotent, and non-destructive. The description adds meaningful behavioral context beyond that: it searches a bundled catalog rather than fetching live data, returns ranked hits with required_parameters, and yields specific errors like unknown_toolset with known_toolsets for invalid filters. This makes the tool's runtime behavior transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured: a one-sentence core statement, a compact numbered workflow, a crucial filter warning, and three concrete examples. There is no filler, and the most important behavioral distinction ('does not fetch data') is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for this tool's complexity. It explains the return shape, the recommended follow-up steps, filter semantics, error behavior, and gives examples. Since an output schema exists, further return-value detail is unnecessary. An agent has everything needed to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description reinforces key points such as query being a natural-language search and source/toolset being optional filters, but it does not add substantial parameter meaning beyond the schema. Baseline 3 is appropriate because the schema carries the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Search the bundled Sugra endpoint catalog by natural-language query.' It also clarifies the tool's role in the workflow ('Use this to pick an operation_id') and explicitly distinguishes it from data-fetching tools ('It does not fetch data'). This fully separates it from siblings like call_endpoint and describe_endpoint.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit guidance on when to use the tool and how it fits into a typical loop with describe_endpoint and call_endpoint/fetch_data. It also warns about filter usage: 'Filter with toolset or source only after list_toolsets / list_sources' and explains misspelled filters produce errors, not empty results. This is clear, actionable usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sugra_entity_lookupARead-onlyIdempotentInspect
Resolve an entity by identifier and return its composed KYB envelope.
anchor is lei (Legal Entity Identifier, resolved via the GLEIF registry)
or vat (EU VAT number, validated via the EU VIES service). The result
weaves identity, a sanctions screening signal, and - on request - ownership
and adverse-media slices.
The screening verdict is a SCREENING SIGNAL, not a compliance determination,
and any PEP / adverse-media content is supplementary and non-comprehensive.
The disclaimer field carries this and is always present.
Output is COMPACT by default to protect the agent context budget:
{entity:{name, anchor, value, status, country}, screening:{status, top_matches:[...3], hit_count}, ids:{...}, disclaimer}. Pass include to
opt INTO fuller per-slice detail, e.g.
include=["ownership","adverse_media"] adds those slices in full form.
On a bad anchor or an API error this returns a clean {error, detail} dict
rather than raising, so the agent can branch on result.get("error").
Args:
anchor: Identifier type, one of lei or vat.
value: The identifier value (the 20-char LEI code or the VAT number).
include: Optional list of fuller slices to add, e.g.
["ownership", "adverse_media"]. Omit for the compact default.
| Name | Required | Description | Default |
|---|---|---|---|
| value | Yes | The identifier value: 20-character LEI or the VAT number. | |
| anchor | Yes | Identifier type: lei (GLEIF) or vat (EU VIES). | |
| include | No | Optional fuller slices to add, e.g. ownership, adverse_media. Omit for the compact default. profile and screening are already in the compact core and are not extra slices. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal read-only/idempotent behavior, and the description adds substantial behavioral detail: compact-by-default output to protect context budget, a clean {error, detail} dict instead of exceptions, always-present disclaimer, and the caveat that screening is a signal rather than a compliance determination. This goes well beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with purpose, then gives the output contract, error behavior, and parameter semantics in a clear, labeled structure. Every sentence earns its place without padding.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only lookup tool, the description covers input constraints, return shape, optional parameters, error behavior, and important caveats. With the annotations and output schema available, nothing essential is missing for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Even though schema coverage is 100%, the description adds real semantic value: it explains that lei resolves via GLEIF and vat via VIES, specifies the value formats, and clarifies that include opts into fuller slices while the default is compact. This materially improves correct invocation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb ('Resolve an entity by identifier') and names the concrete deliverable ('composed KYB envelope'), so an agent can tell what the tool does. However, it does not explicitly distinguish this tool from siblings like sugra_entity_screen or resolve_entity, so it misses the top differentiator.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives clear usage context: identifier-based lookup with lei/vat, optional include slices, and the compact-vs-full output behavior. It also tells the agent how to handle errors by branching on result.get('error'). It does not state when not to use this tool or name an alternative, but the guidance given is unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sugra_entity_screenARead-onlyIdempotentInspect
Screen a person or organization name against the Sugra sanctions corpus.
Returns a SCREENING SIGNAL, not a compliance determination. Sugra is a
technology provider, not a sanctions authority or consumer reporting agency.
PEP and adverse-media coverage is supplementary and non-comprehensive - a
clear result is not proof of absence, and a hit is a candidate match to
review, not a finding.
Output is COMPACT to protect the agent context budget:
{status, matches:[{name, score, list, type}], disclaimer}. The verdict
status is one of clear, review, or hit. The heavy raw fields
(match rationale, source ids, publish dates) are dropped; use the Sugra API
directly when the full screening envelope is needed.
Args: name: The person or organization name to screen (required). country: Optional ISO 3166-1 alpha-2 country to narrow the match. dob: Optional date of birth (YYYY-MM-DD) for a person. nationality: Optional nationality to narrow the match.
| Name | Required | Description | Default |
|---|---|---|---|
| dob | No | Optional date of birth for a person, YYYY-MM-DD. | |
| name | Yes | Person or organization name to screen (required). | |
| country | No | Optional ISO 3166-1 alpha-2 country to narrow the match. | |
| nationality | No | Optional nationality to narrow the match. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. The description adds meaningful behavioral context: it returns a signal, not a compliance determination; it warns that a 'clear' result is not proof of absence and a 'hit' is a candidate match; and it describes the compact output structure (status, matches, disclaimer). This goes beyond the annotations by explaining the semantic limitations and output shape, though it could mention error handling or edge cases for a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured and front-loaded: it opens with the purpose, then explains the output and its rationale, then lists parameters. It is reasonably concise for the complexity of the tool, with no redundant fluff. Each paragraph earns its place, and the important caveats are prominently placed.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is moderately complex with disclaimers and a specific output format. The description covers the output schema (including the structure and status values), explains the non-comprehensive nature, and mentions the compactness for context budget. It lacks details on error conditions, rate limits, or exact match scoring, but the presence of an output schema and the thorough description make it largely complete for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers all four parameters with descriptions (100% coverage). The description's Args section largely repeats the schema's descriptions (e.g., country is ISO 3166-1 alpha-2, dob is YYYY-MM-DD). It adds minimal extra meaning beyond the schema, such as implying these are filters to narrow the match, but that is already implicit. Per the rubric, with high schema coverage, the baseline is 3; the description does not sufficiently enhance parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb ('screen') and resource ('a person or organization name against the Sugra sanctions corpus'). It distinguishes this from a compliance determination and positions it as a screening signal, making the tool's purpose unambiguous and distinct from sibling tools like sugra_entity_lookup which likely focuses on lookup rather than screening.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context on when this tool is appropriate: it returns a compact screening signal to protect the agent context budget, and explicitly says to use the Sugra API directly when the full screening envelope is needed. However, it does not name sibling tools or explicitly contrast with them, so the guidance is clear but not exhaustive regarding alternative MCP tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
8 tool updates
v0.11.0- Changed
call_endpoint3 fields changed- added
Input schema / properties / fields / descriptionAdded value: +"Optional projection of keys to keep on each record. Dotted paths (geo.city) walk nested objects. meta.shaped reports fields_applied and fields_unmatched. Omit to keep every key." - added
Input schema / properties / include_raw / descriptionAdded value: +"If true, attach the original unshaped payload under raw when it fits the size cap; otherwise meta.raw_omitted explains why. Default false." - added
Input schema / properties / limit / descriptionAdded value: +"Bounds ONLY the top-level list: the envelope data list (or a bare top-level array). Nested lists inside records are never truncated; meta.shaped reports whether the limit applied."
- Added
describe_endpoint - Added
fetch_data - Added
list_sources - Added
list_toolsets - Changed
search_endpoints4 fields changed- added
Input schema / properties / limit / descriptionAdded value: +"Maximum ranked hits to return. Default 10. Does not call the Sugra API; this only bounds the catalog search list." - added
Input schema / properties / query / descriptionAdded value: +"Natural-language search over the bundled catalog. Name the instrument, series, place, or task (examples: 'US CPI', 'AAPL quote', 'North Sea AIS'). Returns ranked operation_id hits with required_parameters. Then call describe_endpoint on a hit before call_endpoint." - added
Input schema / properties / source / descriptionAdded value: +"Optional source-family filter as listed by list_sources (macro, markets, ...). An unknown value returns error unknown_source with known_sources." - added
Input schema / properties / toolset / descriptionAdded value: +"Optional catalog group filter (markets, macro, news, network, ...). Call list_toolsets for the live names. An unknown value returns error unknown_toolset with known_toolsets rather than an empty hit list."
- Added
sugra_entity_lookup - Added
sugra_entity_screen
7 tool updates
v0.9.1- Changed
call_endpoint2 fields changed- changed
Input schema / properties / body / anyOfPrevious value: -[ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } -]New value: +[ + { + "additionalProperties": true, + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "null" + } +] - changed
Input schema / properties / body / descriptionPrevious value: -"JSON request body for a POST operation, matching the request_body_schema returned by describe_endpoint(operation_id). Omit for GET operations."New value: +"JSON request body for a POST operation, matching the request_body_schema returned by describe_endpoint(operation_id): a JSON object for most operations, or a JSON array when that schema's top-level type is array. Omit for GET operations."
- Removed
describe_endpoint - Removed
fetch_data - Removed
list_sources - Removed
list_toolsets - Removed
sugra_entity_lookup - Removed
sugra_entity_screen
8 tool updates
v0.8.2- First observed
call_endpoint - First observed
describe_endpoint - First observed
fetch_data - First observed
list_sources - First observed
list_toolsets - First observed
search_endpoints - First observed
sugra_entity_lookup - First observed
sugra_entity_screen
TDQS
Scored across 8 tools
Most tools have clearly distinct purposes: entity screening, identifier lookup, catalog search/describe/call, and listing. Some ambiguity exists between sugra_entity_screen and sugra_entity_lookup (both produce screening signals) and between fetch_data and the search_endpoints/call_endpoint workflow, but descriptions make the intended use clear.
The catalog tools consistently use verb_noun names like search_endpoints, describe_endpoint, call_endpoint, list_toolsets, and list_sources. The two entity tools use a different pattern with the sugra_entity_ prefix, creating a minor but noticeable inconsistency.
Eight tools is well-scoped for a server that combines two specialized entity operations with a general endpoint-catalog workflow. Each tool earns its place, and the count avoids both sprawl and thinness.
The tool set covers the full loop for entity screening and identifier-based KYB lookup, plus discovery and execution of catalog endpoints via search, describe, and call. The one-step fetch_data and structured error handling prevent dead ends.
Maintenance
Related MCP Connectors
Unified financial infrastructure connecting AI agents directly to trade live/demo brokerage accounts, Web3 non-custodial wallets, real-time market data across equities, ETFs, crypto, forex, options, DeFi swaps, and prediction markets, institutional research feeds, and algorithmic strategy backtesters.
Real-time data API for AI Agents: stocks, weather, forex, logistics, search, scrape, news, IP.
Give your agent web search and authoritative datasets: S&P Global, FRED, OECD, SimilarWeb & more.
Curated marketplace of real-world data APIs for AI agents, paid per call in USDC on Solana.
Related MCP Servers
AlicenseBqualityAmaintenanceUS/HK markets — 110 tools: real-time quotes, options, orders, fundamentals, alerts, DCA & portfolio16513Apache 2.0
BlockRun MCPofficial
AlicenseAqualityAmaintenanceProvides Claude with real-time access to markets, research, X/Twitter, and crypto data via a unified pay-per-call system with no API keys.191,144 npm391MIT- FlicenseNot gradedqualityDmaintenanceEnables AI agents to access real-time financial data including crypto, equities, on-chain, prediction markets, and macro via a single API key.-
- AlicenseNot gradedqualityCmaintenanceProvides live data API for AI agents with 51 REST endpoints across finance, travel, weather, news, and more, using USDC micropayments without API keys.76 npmMIT