The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Quality Screener listing page.
A standalone Model Context Protocol (MCP) server that exposes the Quality Screener stock-screening engine as tools for AI agents (Claude, Cursor, and any other MCP client).
Once connected, an agent can screen and filter the scored universe, compute custom quality scores, inspect score history, manage saved scoring systems, and generate shareable screen links — acting as the signed-in user, against the same data they see in the web dashboard.
CustomScoreConfigEach MCP tool maps to one Quality Screener REST endpoint. The server attaches
the caller's bearer token to every outbound request (header
X-Stobot-CLI-Token, Authorization: Bearer … also accepted) and returns the
decoded JSON. There is no business logic in the server itself — it is a typed,
authenticated façade over the API.
It runs in two transport modes:
| Transport | Use | Authentication |
|---|---|---|
stdio (default) | A local agent (e.g. Claude Code) launches the server as a subprocess | Token from $QSCREENER_TOKEN or ~/.config/qscreener/credentials.json |
streamable-http | A remote, externally reachable deployment (e.g. Railway) | End-to-end MCP OAuth 2.0 — the client opens the browser once, then sends the token automatically; or a per-request X-Stobot-CLI-Token header |
Over HTTP the MCP endpoint is served at /mcp.
The easiest way to use the server is to point your MCP client at the hosted deployment. No token to copy — the client triggers a browser sign-in on first connect:
On first use your browser opens the Quality Screener sign-in page. Approve once, and the agent stays connected. You need a Quality Screener account; the agent inherits exactly your access.
Requires uv.
With Docker:
By default the container runs the streamable-http transport on port 8080.
All configuration is via environment variables, resolved at startup.
| Env var | Default | Meaning |
|---|---|---|
QSCREENER_API_URL | http://localhost:8001 | Base URL of the Quality Screener backend API the tools call |
QSCREENER_MCP_TRANSPORT | stdio | stdio, streamable-http, or sse |
QSCREENER_WEBSITE_URL | http://localhost:3001 | Web-app base URL used to build the OAuth browser-login link and shareable screen URLs |
QSCREENER_MCP_PUBLIC_URL | http://localhost:{PORT|8080} | Publicly reachable base URL of this server; used to build the OAuth callback URL |
PORT | — | Bind port for HTTP transports (Railway sets this automatically) |
QSCREENER_MCP_PORT | 8080 | Bind port fallback when PORT is unset |
QSCREENER_MCP_HOST | 0.0.0.0 | Bind host for HTTP transports |
QSCREENER_TOKEN | — | Bearer-token override for stdio mode (single user) |
QSCREENER_CONFIG_DIR | ~/.config/qscreener | Directory holding credentials.json for stdio mode |
The server resolves a bearer token for each call with the following precedence:
X-Stobot-CLI-Token, then Authorization: Bearer <token>.$QSCREENER_TOKEN environment variable.$QSCREENER_CONFIG_DIR/credentials.json — the token field.For a streamable-http deployment, authentication is fully automated via the
MCP OAuth flow:
/oauth/callback.The token is validated on each request by calling the backend's
/v1/cli/auth/whoami endpoint, so a revoked or expired token is rejected
immediately. The server never persists user tokens.
Mint a token through the browser login flow and store it locally, then run the server over stdio:
Or set QSCREENER_TOKEN directly for CI / scripted use.
All tools require authentication. Filters use OR logic within a filter and AND logic across filters. Market caps are always in USD.
| Tool | Signature | Description |
|---|---|---|
auth_status | auth_status() | Whether a token is present and which user it authenticates as. |
account_profile | account_profile() | The signed-in user's profile (email, username, organization). |
health | health() | API and database health check. |
| Tool | Signature | Description |
|---|---|---|
scores_top | scores_top(limit=20) | Top tickers by quality score, as a {ticker: score} map. |
scores_list | scores_list(ticker=None, sectors=None, industries=None, countries=None, currencies=None, exchanges=None, min_score=None, max_score=None, min_market_cap_usd=None, max_market_cap_usd=None, sort_by="quality_score", sort_order="desc", offset=0, limit=50, include_duplicates=False) | List scored tickers with optional filters. |
scores_show | scores_show(ticker) | Full score row(s) for a single ticker. |
scores_for_tickers | scores_for_tickers(tickers, scoring_system_id=None) | Current scores for a specific list of tickers, under default scoring or a saved scoring system. Unknown tickers are omitted. |
scores_statistics | scores_statistics(sectors=None, min_score=None, max_score=None, min_market_cap_usd=None, max_market_cap_usd=None) | Min / max / average score statistics for a filtered universe. |
scores_market_cap | scores_market_cap(sectors=None, min_score=None) | Aggregated total market cap (USD) for a filtered universe. |
score_compute | score_compute(config, scoring_universe=None, sectors=None, industries=None, regions=None, countries=None, currencies=None, exchanges=None, min_market_cap_usd=None, max_market_cap_usd=None, sort_by="quality_score", sort_order="desc", offset=0, limit=50, include_duplicates=False) | Compute custom scores from a CustomScoreConfig. scoring_universe picks the peer group (changes the scores); the other filters select rows (do not). |
| Tool | Signature | Description |
|---|---|---|
screen_share | screen_share(config) | Persist a CustomScoreConfig and return a public, copy-pasteable share link (url, slug, created, view_count). Content-addressed: an identical config returns the same link. |
| Tool | Signature | Description |
|---|---|---|
filters_list | filters_list() | Available filter values (sectors, industries, countries, currencies, exchanges). |
tickers_list | tickers_list(limit=None) | Available tickers, optionally truncated to limit. |
tickers_search | tickers_search(query) | Search available tickers by case-insensitive substring. |
Dates are YYYY-MM-DD. Pass scoring_system_id to compute history against a
saved scoring system instead of the default quality score.
| Tool | Signature | Description |
|---|---|---|
history_ticker | history_ticker(ticker, start=None, end=None, scoring_system_id=None) | Score history for a single ticker over a date range. |
history_batch | history_batch(tickers, start=None, end=None, scoring_system_id=None) | Score history for several tickers at once. |
history_top | history_top(top=10, scoring_system_id=None) | Fetch the current top-N tickers and return their score history. |
A scoring system is a named, reusable CustomScoreConfig stored against your
account.
| Tool | Signature | Description |
|---|---|---|
systems_list | systems_list() | List your saved scoring systems. |
systems_show | systems_show(system_id) | Show a saved scoring system by ID. |
systems_create | systems_create(name, config, description=None) | Create a saved scoring system from a config object. |
systems_update | systems_update(system_id, name=None, config=None, description=None) | Update a saved scoring system. |
systems_delete | systems_delete(system_id) | Delete a saved scoring system. |
systems_apply | systems_apply(system_id) | Apply a saved scoring system (increments its usage count). |
CustomScoreConfigscore_compute, screen_share, and the systems_* tools accept a
CustomScoreConfig object describing how to weight financial metrics. Its shape
mirrors the score builder in the web dashboard: weighted metric groups, each
containing weighted metrics, plus scoring parameters and an optional nested
filters block. A minimal example:
Scoring parameters use camelCase: winsorizePercentile (1-10), missingDataPercentile
(0.1-0.5), normalizeGroupZScores and includeDuplicatesInScoring (booleans).
scoringUniverseFilters defines the peer group the scores are computed against; the nested
filters block holds saved-screen state. Market caps are in billions USD inside both
blocks (the tool arguments take USD). Loose inputs — snake_case keys, the legacy
winsorize/zScore flags, or filter keys placed at the top level — are normalized to this
shape automatically, but emitting it directly is preferred. Use filters_list to discover valid filter values, and build a config
interactively in the dashboard if you want a starting point to copy.
Quality scores are relative — every company is winsorized and z-scored against a
population — so who is in the peer group and which rows you look at are different
questions, and score_compute takes them separately.
| Stage | Where | Effect |
|---|---|---|
| 1. Scoring universe | scoring_universe argument, or config.scoringUniverseFilters | applied before winsorize/z-score — changes every score |
| 2. Result filters | the sectors / countries / … arguments | applied after scoring — never changes a score |
"Best European tech judged against European tech" and "best European tech judged against the world" are different lists, not the same list rescaled — narrowing the universe moves each metric's bounds, mean and σ by different amounts, so companies genuinely reorder:
Stage 1 accepts sectors, industries, regions, countries, currencies, exchanges,
min_market_cap_usd and max_market_cap_usd. It rejects min_score, max_score, ticker
and tickers with an error rather than ignoring them: the first two filter on the very
scores being computed, the rest select rows.
Every response carries a scoring_universe field naming the peer group and its size. Scores
computed against different peer groups are not comparable — do not mix them in one table.
Two edges worth knowing:
min_market_cap_usd as a stage-2 argument also floors the scoring population. This is
long-standing backend behaviour, kept for compatibility. Set min_market_cap_usd inside
scoring_universe to control the peer group explicitly; it overrides the stage-2 floor.
max_market_cap_usd filters rows only unless you set it in scoring_universe.filters block doesIt is saved-screen state. screen_share and systems_create/systems_update persist
it so a shared screen or saved scoring system restores its filter selections when reopened
in the dashboard.
It does not define the peer group — scoringUniverseFilters does. Passing a saved config to
score_compute applies its filters block as stage-2 filters (an explicit argument
wins), matching what the dashboard does, so re-scoring a saved system keeps its view.
Any streamable-http MCP client works. No token needed — OAuth handles login:
If your client cannot perform the OAuth flow, send a minted token directly:
The server deploys as a single container. On Railway:
New service → Deploy from repo, pointing at this repository. The Dockerfile is self-contained, so the build context is the repo root.
Set environment variables:
QSCREENER_MCP_TRANSPORT=streamable-httpQSCREENER_API_URL=https://<your-backend-domain>QSCREENER_WEBSITE_URL=https://<your-frontend-domain>QSCREENER_MCP_PUBLIC_URL=https://<generated-mcp-domain>Railway injects PORT automatically; the server binds to it.
Networking → Generate Domain. The MCP endpoint is
https://<generated-domain>/mcp.
/mcp answers
406 Not Acceptable to a plain GET, so an HTTP healthcheck expecting
200 would mark the deploy unhealthy.Connect your MCP client — the OAuth flow triggers automatically on first connection.
The codebase is small and self-contained:
| Path | Purpose |
|---|---|
qscreener_mcp/server.py | FastMCP server, tool definitions, transport entry point |
qscreener_mcp/client.py | Minimal httpx client that attaches the bearer token |
qscreener_mcp/oauth.py | MCP OAuth 2.0 provider (token validation, browser flow) |
tests/ | pytest suite (token resolution, filter forwarding, share-link building) |
The full privacy policy is published at PRIVACY.md (https://github.com/quality-screener/quality-screener-mcp-server/blob/main/PRIVACY.md).
In short:
See the policy for retention periods, third-party recipients, international transfers, and your GDPR rights.
| Channel | Use it for |
|---|---|
| info@qualityscreener.io | Support requests, security reports, privacy and data-subject requests |
| GitHub Issues | Bug reports and feature requests |
This README is the canonical documentation for the MCP server: https://github.com/quality-screener/quality-screener-mcp-server
Please report suspected security vulnerabilities privately by email rather than opening a public issue.
MIT © Quality Screener.