MCP tools
The DEBYKO MCP server (https://mcp.debyko.com/mcp) offers 18 tools when Account is configured. 11 are offered to every connection; agent_rule_get reads saved Agent rules when Account is configured. The 6 Agent write tools (agent_channels, agent_channel_connect, agent_rule_create, agent_rule_set, agent_rule_delete, agent_set_enabled) are turned on account by account, and a connection without them is not offered them at all. Each is one call to the DEBYKO API or Account’s Agent API with your key; what it costs on your key is the last sentence of its description. A refusal carries code, next and retry: see Errors.
| Tool | Title | What it does | Offered |
|---|---|---|---|
venues |
DEBYKO venues | reads only | always |
instruments |
DEBYKO instruments | reads only | always |
snapshots |
DEBYKO snapshots | reads only | always |
history |
DEBYKO snapshot history | reads only | always |
screen |
DEBYKO screen | reads only | always |
candles |
DEBYKO candles | reads only | always |
funding_settlements |
DEBYKO funding settlements | reads only | always |
agent_state |
DEBYKO Agent state | reads only | always |
agent_rule_result |
DEBYKO read a candle rule result | reads only | always |
agent_rule_get |
DEBYKO read an alert rule | reads only | when Account is configured |
anchor_proof |
DEBYKO anchor proof | reads only | always |
account |
DEBYKO account | reads only | always |
agent_channels |
DEBYKO Agent channels | reads only | with the Agent tools on |
agent_channel_connect |
DEBYKO connect a channel | changes data; destructive | with the Agent tools on |
agent_rule_create |
DEBYKO create an alert rule | changes data | with the Agent tools on |
agent_rule_set |
DEBYKO change an alert rule | changes data; destructive | with the Agent tools on |
agent_rule_delete |
DEBYKO delete an alert rule | changes data; destructive | with the Agent tools on |
agent_set_enabled |
DEBYKO Agent on or off | changes data; destructive | with the Agent tools on |
venues
Section titled “venues”DEBYKO venues · reads only · offered to every connection
A bounded page of venues DEBYKO collects, with public code, market kind, listing counts, since, hot_days, coverage. kind selects perpetual (default), spot or all. limit defaults to 500 (maximum 500); follow next_cursor until null to read the complete catalogue. Pages share registry_revision. Free: not counted on your key.
Use this when you need venue codes or collection coverage; for venue listings use instruments. To read the full catalogue, follow next_cursor with the same filters until it is null; restart from the first page if the cursor is rejected.
| Argument | Type | Required | Meaning |
|---|---|---|---|
kind |
perpetual, spot, all |
Market kind. Defaults to perpetual; use spot for spot venues or all for both kinds. |
|
limit |
integer | Page size. Defaults to 500. | |
cursor |
string | Opaque next_cursor from the previous page. Keep other request options unchanged. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
instruments
Section titled “instruments”DEBYKO instruments · reads only · offered to every connection
A bounded page of listings (instrument on a venue): venue symbol, market kind, contract specification and collected dataset policy. kind selects perpetual (default), spot or all. where selects (DQL selection grammar), as_of asks about the past, mapped filters mapped/unmapped listings, and collected filters listings collected by current policy. limit defaults to 500 (maximum 500); follow next_cursor until null to read the complete catalogue. Pages share registry_revision. Free: not counted on your key.
Use this when you need listing symbols, market kinds, contract specifications or collection policy; for market values use snapshots. To read the full catalogue, follow next_cursor with the same filters until it is null; restart from the first page if the cursor is rejected.
| Argument | Type | Required | Meaning |
|---|---|---|---|
where |
string | Which listings: a DQL selection over venue, base, quote and instrument, for example base in (BTC) or venue = BINANCE-USDM. Every listing when omitted. symbol is the venue’s own symbol, instrument the market code (BTC-PERP); perpetual or spot is kind. A venue name such as BINANCE-PERP resolves to its code, shown in resolved_from. |
|
kind |
perpetual, spot, all |
Market kind. Defaults to perpetual; use spot for spot listings or all for both kinds. |
|
as_of |
string | An ISO-8601 UTC instant such as 2026-10-01T00:00:00Z: the listings as they stood then. The served_at of an earlier answer replays it. |
|
include_raw |
boolean | Add the venue’s own instrument document to each listing. | |
mapped |
boolean | True returns listings with a resolved instrument; false returns unmapped listings. Omit to include both. | |
collected |
boolean | True returns listings collected by current policy; false returns uncollected listings. Omit to include both. | |
limit |
integer | Page size. Defaults to 500. | |
cursor |
string | Opaque next_cursor from the previous page. Keep other request options unchanged. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
snapshots
Section titled “snapshots”DEBYKO snapshots · reads only · offered to every connection
The latest reading of each layer (layers: ticker, mark, funding, oi, book, stats, venue_depth; all of them when omitted) for the selected listings, each value with its venue and market kind, when it arrived and how old it is. kind selects perpetual (default), spot or all; DQL selection still evaluates perpetual listings only. Up to 500 listings a call. A layer that is not current is not hidden: it comes back with its status (stale, missing, not_published, off), its reason and its dates, and no value (allow_stale puts a stale value under withheld). missing lists a pair no venue lists (not_listed). Counts as one request on your key.
Use this when you need the latest values now; for values at past instants use history, for price bars use candles, for a condition across venues use screen.
| Argument | Type | Required | Meaning |
|---|---|---|---|
where |
string | Which listings: a DQL selection over venue, base, quote and instrument, for example venue = BYBIT-PERP and base in (BTC, ETH). Omitting it selects every listing, which the limits refuse. instrument is the market code (BTC-PERP), symbol the venue’s own; perpetual or spot is the kind option. A venue name such as BINANCE-PERP resolves to its code, shown in resolved_from. |
|
kind |
perpetual, spot, all |
Market kind to include. Defaults to perpetual; spot and all select spot or both kinds. The DQL selection does not screen spot markets. |
|
units |
published, base |
published (default): each venue’s own unit, which is contracts on some venues. base: converted to the base asset; null with unit_unknown where a contract size is not known, and the answer carries normalisation_version, the conversion rules that produced it (keep it beside stored numbers). |
|
number_format |
json, string |
json (default): numbers as JSON numbers. string: every number as a string with the same digits, for a client whose JSON parser would round them. |
|
layers |
array of string | Which layers to read, any of: ticker, mark, funding, oi, book, stats (24 h statistics), venue_depth. Every layer when omitted. |
|
include_raw |
boolean | Also return each layer’s message as the venue sent it. | |
allow_stale |
boolean | Return a value that is no longer current under withheld, never in the value field. Off by default: a stale value is not in the answer, only its status, reason and dates. For post-mortems; never use withheld for a live decision. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
history
Section titled “history”DEBYKO snapshot history · reads only · offered to every connection
The same snapshot (same layers: ticker, mark, funding, oi, book, stats, venue_depth) as it stood in the past: one row per period (interval), per named instant (at; use the served_at of an earlier answer to replay exactly what it showed) or per message as it arrived (raw), with gaps written out as gaps and their cause (coverage). Up to 100 listings a call, 2,000 rows per layer with interval and 100,000 rows with raw. min/max over a window → history with summary. Counts as one request on your key.
Use this when you need a layer’s values as they stood at past instants or over a past window; for the latest values use snapshots, for price bars use candles.
| Argument | Type | Required | Meaning |
|---|---|---|---|
where |
string | Which listings: a DQL selection over venue, base, quote and instrument, for example venue = HYPERLIQUID and base = BTC. Omitting it selects every listing, which the limits refuse. instrument is the market code (BTC-PERP), symbol the venue’s own; perpetual or spot is the kind option. A venue name such as BINANCE-PERP resolves to its code, shown in resolved_from. |
|
kind |
perpetual, spot, all |
Market kind to include. Defaults to perpetual; spot and all select spot or both kinds. The DQL selection does not screen spot markets. |
|
units |
published, base |
published (default): each venue’s own unit, which is contracts on some venues. base: converted to the base asset; null with unit_unknown where a contract size is not known, and the answer carries normalisation_version, the conversion rules that produced it (keep it beside stored numbers). |
|
number_format |
json, string |
json (default): numbers as JSON numbers. string: every number as a string with the same digits, for a client whose JSON parser would round them. |
|
layers |
array of string | Which layers to read, any of: ticker, mark, funding, oi, book, stats (24 h statistics), venue_depth. |
|
interval |
1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d |
One row per period of this length, each holding the last reading in it. 1m, 5m, 15m, 30m: that many minutes; 1h, 4h, 12h: that many hours; 1d: one UTC day. |
|
at |
array of string | One row per instant, strictly ascending, each an ISO-8601 UTC instant: what history had recorded as of it, the last stored reading visible then (a sampled reading counts from the end of its window, history_cadence in instruments). Refused with from and to. A live answer served at that instant can be newer, by up to one window. |
|
raw |
boolean | Every row as it arrived, unsampled. Needs from and to; at most 100,000 rows a call. |
|
from |
string | Start of the window, an ISO-8601 UTC instant such as 2026-10-06T06:00:00Z. Exclusive: with interval the first row is the period that ends one interval after it. Required with interval and raw; refused with at. |
|
to |
string | End of the window, an ISO-8601 UTC instant such as 2026-10-06T09:00:00Z, after from. Inclusive: with interval the last row is the period that ends at it. Required with interval and raw; refused with at. |
|
include_gaps |
boolean | Keep the rows that have no reading (the default): dropping them turns a gap into a shorter series. | |
summary |
boolean | With interval: per listing and layer, n readings and per numeric field min, max, first, last as [value, time] over from–to, not rows. Extremes are observed at the interval’s samples, not settled amounts. Priced and limited as without it. |
|
fields |
array of string | With summary: only these fields; for funding across venues ["funding_8h"]. |
|
freshness |
string | Override how old a reading may be and still count as current, for every layer asked for: a duration from 1s to 7d, such as 30s or 5m. |
|
allow_stale |
boolean | Return a value that is no longer current under withheld, never in the value field. Off by default: a stale value is not in the answer, only its status, reason and dates. For post-mortems; never use withheld for a live decision. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
screen
Section titled “screen”DEBYKO screen · reads only · offered to every connection
Run a DQL query across venues and return the instruments that match, a page at a time. Give exactly one of query (DQL text) and query_object (the same query as a JSON object). Each value carries its venue, arrival time and age; computed values say derived: true, and an instrument the data could not decide is dropped unless include_unknown is set. Write the query only with fields, functions and periods listed in docs://dql (its section “Plain language → DQL” gives units and common shapes) and venue codes from venues; when the user asked in words, say the query back in plain words next to the result. Counts as one request on your key.
Use this when you need the instruments that meet a condition across venues; for the values of listings you already know use snapshots.
| Argument | Type | Required | Meaning |
|---|---|---|---|
query |
string | The query as DQL text, for example count(venues where funding_8h > 1bps) >= 3 (funding above 1 bp per 8 h on at least three venues) or max(venues where quote in (USDT, USDC, USD), mark) / min(venues where quote in (USDT, USDC, USD), mark) - 1 > 10bps (mark prices more than 10 bp apart across venues). Full grammar: resource docs://dql. Exactly one of query and query_object. |
|
query_object |
object | The same query as a JSON object (DQL’s machine form), for a client that builds queries as data. Exactly one of query and query_object. |
|
limit |
integer | How many instruments to return in one page. account states the ceiling of your plan. |
|
cursor |
string | A cursor from a previous answer’s page.next_cursor. It pins the instant, so page two sees the world page one saw. |
|
include_unknown |
boolean | Also return the instruments the data could not decide, with result: unknown, instead of dropping them. Ask for this whenever coverage matters. |
|
include_atoms |
boolean | Also return, for every value the platform computed, the values it was computed from — each with its own venue, receipt time, age and status. derived: true marks a computed value whether or not this is asked for; this adds the evidence behind it. Off by default because the evidence is several times the size of the answer. |
|
units |
published, base |
published (default): each venue’s own unit, which is contracts on some venues. base: converted to the base asset; null with unit_unknown where a contract size is not known, and the answer carries normalisation_version, the conversion rules that produced it (keep it beside stored numbers). |
|
number_format |
json, string |
json (default): numbers as JSON numbers. string: every number as a string with the same digits, for a client whose JSON parser would round them. |
|
allow_stale |
boolean | Return a value that is no longer current under withheld, never in the value field. Off by default: a stale value is not in the answer, only its status, reason and dates. For post-mortems; never use withheld for a live decision. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
candles
Section titled “candles”DEBYKO candles · reads only · offered to every connection
Completed OHLCV bars; unreported periods are gap, never invented. At most 100 listings and 1,500 bars per listing. Relative windows use the current UTC served_at of a recent answer, never from documentation example dates. Several bases can exceed 100 quote pairs: split the same selection, preserving every requested product; do not drop quote currencies unless the user chose one. Depth by timeframe: Free 1m 48 hours, 5m/15m 7 days, 1h 30 days, 4h/1d 90 days; Mini 7/30/90/180 days; Standard+: plan.history. PLAN_LIMIT names the depth, deeper plan, earliest from and retry_with. Counts as one request on your key.
Use this when you need open, high, low and close bars over a window; for a layer’s values at past instants use history, for the latest values use snapshots.
| Argument | Type | Required | Meaning |
|---|---|---|---|
where |
string | Which listings: a DQL selection over venue, base, quote and instrument, for example venue = BINANCE-USDM and base = ETH. Omitting it selects every listing, which the limits refuse. instrument is the market code (BTC-PERP), symbol the venue’s own; perpetual or spot is the kind option. A venue name such as BINANCE-PERP resolves to its code, shown in resolved_from. |
|
kind |
perpetual, spot, all |
Market kind to include. Defaults to perpetual; spot and all select spot or both kinds. The DQL selection does not screen spot markets. |
|
units |
published, base |
published (default): each venue’s own unit, which is contracts on some venues. base: converted to the base asset; null with unit_unknown where a contract size is not known, and the answer carries normalisation_version, the conversion rules that produced it (keep it beside stored numbers). |
|
number_format |
json, string |
json (default): numbers as JSON numbers. string: every number as a string with the same digits, for a client whose JSON parser would round them. |
|
timeframe |
1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d |
yes | The bar length. 1m, 5m, 15m, 30m: that many minutes; 1h, 4h, 12h: that many hours; 1d: one UTC day. 1m is the venue’s kline; longer bars roll up from it, or are venue klines marked origin: "backfill". |
price_type |
trade, mark, index |
trade (default): bars of the traded price. mark: bars of the venue’s mark price. index: bars of the venue’s index price. A venue that does not publish one answers with a status. |
|
from |
string | yes | Start of the window, an ISO-8601 UTC instant such as 2026-10-06T06:00:00Z, rounded down to the bar. Inclusive: the first bar is the one that opens at it. At most 1,500 bars between from and to. |
to |
string | yes | End of the window, an ISO-8601 UTC instant such as 2026-10-06T09:00:00Z, after from, rounded down to the bar. Exclusive: the last bar is the one that closes at it. A window that reaches past now ends at the last closed bar. |
include_gaps |
boolean | Keep periods with no candle as gap rows (default): dropping them shortens the series. |
|
as_of |
string | Receipt-time availability cutoff. to bounds candle closes; as_of bounds when their input was available. Defaults to now. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
funding_settlements
Section titled “funding_settlements”DEBYKO funding settlements · reads only · offered to every connection
One row for each time a venue settled a listing’s funding, newest first: the settlement time, the rate as the venue published it for its own interval (rate_8h restates it), the interval in force and its interval_check against the venue’s published one (a mismatch is flagged, never corrected), origin (live recorded as it settled, backfill read from the venue’s history), and cap, floor, at_cap. A print with no rate is missing, never zero; not_recorded names venues with no prints. Window (from, to], a week by default; 1,000 rows a page, follow next_cursor. Depth is the plan’s history (PLAN_LIMIT with earliest_from and retry_with). min/max over a window → history with summary. Counts as one request on your key.
Use this when you need what a venue actually charged at each funding settlement; for the current funding rate and next settlement use snapshots, for sampled values over a window use history.
| Argument | Type | Required | Meaning |
|---|---|---|---|
where |
string | Which listings: a DQL selection over venue, base, quote and instrument, for example venue = BINANCE-USDM and instrument = BTC-PERP. Omitting it selects every listing, which the limits refuse. instrument is the market code (BTC-PERP), symbol the venue’s own; perpetual or spot is the kind option. A venue name such as BINANCE-PERP resolves to its code, shown in resolved_from. |
|
from |
string | Window start, an ISO-8601 UTC instant such as 2026-09-23T00:00:00Z, exclusive. Defaults to a week before to, or as far back as the plan reads. |
|
to |
string | Window end, an ISO-8601 UTC instant, inclusive. Defaults to now. | |
order |
desc, asc |
desc (default): newest first. asc: oldest first. |
|
limit |
integer | Rows of a page. | |
cursor |
string | The previous page’s next_cursor; keep where and order unchanged. |
|
number_format |
json, string |
json (default): numbers as JSON numbers. string: every number as a string with the same digits, for a client whose JSON parser would round them. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
agent_state
Section titled “agent_state”DEBYKO Agent state · reads only · offered to every connection
The state of the account’s Agent rules, polled: per rule state (true, false or unknown, with a reason when it is unknown), previous_state (what this key was told the last time it asked about the rule, null the first time), evaluated_at and effective_interval, and an evaluations block with what the account has used of its evaluations a day. rule_id narrows to those rules (UUIDs, comma separated); leave it out for every rule of the account. fresh=true evaluates the rules now instead of reading the last scheduled evaluation, and is charged against the plan’s evaluations/day budget. Reasons and fields are returned as the API states them. Counts as one request on your key.
Use this when the user asks for their DEBYKO rules, alerts, signals, active conditions or when a rule last fired (also: правила, алерты, сигналы, moi pravila); for the saved DQL of one rule use agent_rule_get.
| Argument | Type | Required | Meaning |
|---|---|---|---|
rule_id |
string | Rule ids (UUIDs), comma separated, to ask about; they must all be the account’s. Omit for every rule of the account. | |
fresh |
boolean | Evaluate the rules now. Charged against the plan’s evaluations/day budget. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
agent_rule_result
Section titled “agent_rule_result”DEBYKO read a candle rule result · reads only · offered to every connection
Reads the persisted live candle result for one rule, instrument and UTC bar_end: true, false or unknown with reason, data_as_of, actual evaluation times, attempt, final and receipt_id. Absence of webhook never means false; not_measured means no retained observation. Results are retained seven days. Use agent_state to resolve rule_id. Counts as one request on your key.
Use this when comparing an independent candle calculation or distinguishing false from missing inputs for a particular candle; for current account-wide rule states use agent_state.
| Argument | Type | Required | Meaning |
|---|---|---|---|
rule_id |
string | yes | The rule’s id, as agent_rule_create returned it or agent_state lists it. |
instrument |
string | yes | Canonical watched instrument, for example BTC-PERP. |
bar_end |
string | yes | UTC candle close on the rule timeframe, for example 2026-10-11T12:00:00Z. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
agent_rule_get
Section titled “agent_rule_get”DEBYKO read an alert rule · reads only · offered when Account is configured
Reads one of your saved DEBYKO Agent alert rules by rule_id or exact label. Returns its original persisted DQL condition, label, status, interval, channels, last firing and history (times it would have fired in 30 days; past fact). Sends nothing, no evaluation budget. No webhook URL or credential. Requires an account key. Not counted on your key.
Use this when the user asks what a named DEBYKO rule checks, requests its DQL, or wants that rule explained (also: что проверяет правило); for current true/false state use agent_state.
| Argument | Type | Required | Meaning |
|---|---|---|---|
rule_id |
string | The rule’s id, as agent_rule_create returned it or agent_state lists it. | |
label |
string | The exact visible rule label, for example BYKO_V2_BREAKOUT_LONG. If labels collide, use rule_id from agent_state. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
anchor_proof
Section titled “anchor_proof”DEBYKO anchor proof · reads only · offered to every connection
A row of DEBYKO’s stored history and the Merkle path from it to the root of its UTC day, which is posted to a contract on Base within 24 hours of the day’s end: the canonical text of the row, its hash, index of rows, the audit path to the partition, the partition’s leaf and the path to day_root, and where that root is on the chain. Verify it with SHA-256 alone (docs.debyko.com/attest/verify). The anchor proves the data did not change after the anchor time; it proves nothing about its correctness at collection. A day not yet anchored, a row never stored or already dropped by retention, and a row changed since the anchor are each their own error code. Counts as one request on your key.
Use this when you need to prove that a stored history row has not changed since its day was anchored; for the row’s values use history.
| Argument | Type | Required | Meaning |
|---|---|---|---|
venue |
string | yes | The venue’s public code, as venues lists it. |
symbol |
string | yes | The listing’s symbol as the venue publishes it, as instruments lists it. |
layer |
ticker, mark, funding, oi, stats, book, trade, liquidation, candles |
yes | The stored layer the row is of: ticker, mark, funding, oi, stats (24 h statistics), book, trade, liquidation or candles. |
at |
string | yes | The row’s own time (its bucket, trade time or candle open), RFC 3339 to the microsecond: 2026-09-24T12:00:00.123456Z. |
tie |
string | Picks among rows at the same instant: a trade’s venue_uid, a candle’s price_type, a liquidation’s generation. |
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
account
Section titled “account”DEBYKO account · reads only · offered to every connection
What this key sees and what is left of it today: the plan (plan.history), the platform venues (venues.included), the layers, the limits, and today’s counters against them (requests with the remainder and by class, DQL, streams, Agent evaluations, archive files). Read-only. Needs a key; free: it is not counted as a request on the key.
Use this when you need your plan’s venues, limits or what is left of them today, before a long job or after a call was refused for the plan; for every venue DEBYKO collects use venues.
No arguments.
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
agent_channels
Section titled “agent_channels”DEBYKO Agent channels · reads only · offered with the Agent tools on
Where the account’s Agent alerts can go, and in what state: Telegram (linked with the chat, pending while a link waits for Start, not_linked, or disabled with the reason), email (not_confirmed until confirmed) and webhooks (masked address, working, failing or not_set_up, last delivery), the plan’s channel limits and shortest check interval, today’s notifications against the daily limit (notifications, with PLAN_NOTIFICATION_LIMIT and retry_after once used), and whether Agent is on. Call it before agent_rule_create, and again after the user says they pressed Start in Telegram. With no channel, ask the user whether they want Telegram, email or a webhook and follow next. Not counted on your key.
Use this when you need to know where the account’s alerts can be sent; to add a channel use agent_channel_connect.
No arguments.
Annotations: readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false.
agent_channel_connect
Section titled “agent_channel_connect”DEBYKO connect a channel · changes data; destructive · offered with the Agent tools on
Connects a channel for Agent alerts. {kind: "telegram"} returns a one-time link to @debyko_bot (it works once, for 10 minutes) and the steps; {kind: "email"} emails a confirmation link to the account’s address; {kind: "webhook", url} adds the webhook, sends it a test message and returns its status. First ask the user which they want, and for a webhook its public https:// address. Give the user next as numbered steps, link exactly as returned; after they say they pressed Start or confirmed, check with agent_channels. The webhook’s signing key is never returned here: next says where the user gets it. Not counted on your key.
Use this when the account has no channel for an alert, or the user wants another one; to see the channels it has use agent_channels.
| Argument | Type | Required | Meaning |
|---|---|---|---|
kind |
telegram, email, webhook |
yes | telegram: a link the user opens to link their chat. email: the account’s address. webhook: an https:// receiver of the user’s. |
url |
string | With webhook: the receiver’s public https:// address. Not used with telegram. |
|
name |
string | With webhook: a name for it; the host of the address when left out. |
Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: false, openWorldHint: true.
agent_rule_create
Section titled “agent_rule_create”DEBYKO create an alert rule · changes data · offered with the Agent tools on
Creates an Agent alert rule: DEBYKO checks a DQL condition every interval_s seconds and notifies the chosen channels the first time it turns from false to true, with the user’s label and the facts (instrument, venue, value, time UTC), never buy or sell. Before calling, make the condition concrete with the user: DEBYKO has no user positions, so if the user describes a loss or an entry (‘when I’m down 5%’), ask for the entry price and compute the level; never guess. Write the DQL only with names listed in docs://dql (see “Plain language → DQL”) and venue codes from venues; every plan can use every venue and instrument. Before saving, restate the DQL to the user in plain words and let them correct it. Ask the user for the label. Call agent_channels first, and when it shows more than one channel ask which ones. After: show the dry run (dry_run, per venue values, and notifications.text: notifications per firing and how many of the day’s are used): if currently is true, say what next says and offer to adjust the level; then tell the user how to turn it off (turn_off). A refusal (no channel, a plan limit, a stopped Agent) carries next: give it to the user as written. Not counted on your key.
Use this when the user wants to be notified when a market condition turns true; to change or pause a rule use agent_rule_set, to test a condition without saving use screen.
| Argument | Type | Required | Meaning |
|---|---|---|---|
dql |
string | yes | The condition as DQL for the instruments to watch, for example any(venues where venue in (MEXC-PERP) and last < 80000) where instrument = BTC-PERP. Grammar: resource docs://dql; use only venues of the user’s plan (the account tool lists them). |
label |
string | yes | The alert’s name, written by the user: the first line of every notification (at most 200 characters, shown as plain text). |
interval_s |
integer | Check interval in seconds. Default: the plan’s shortest (limits.min_interval_s of agent_channels); shorter gives PLAN_INTERVAL_TOO_SHORT. |
|
mode |
live, settled |
Execution mode. Live candle rules first attempt 15s after close; settled waits for stable history. Existing rules change only with an explicit mode selection. | |
channels |
array of string | Where the notifications go: any number of channel ids from agent_channels, mixing Telegram chats and webhooks; telegram or webhook stands for every channel of that kind. Leave it out only when the account has exactly one channel. Each channel a firing reaches counts as one of the plan’s daily notifications. |
|
fire_mode |
edge, remind |
remind also notifies every remind_every_s while true (Telegram, email). Default edge. |
|
remind_every_s |
integer | Seconds, remind mode. Default 3600. | |
notify_on_enable |
boolean | Notify once if already true when turned on. Default true for a new rule. |
Annotations: readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: true.
agent_rule_set
Section titled “agent_rule_set”DEBYKO change an alert rule · changes data; destructive · offered with the Agent tools on
Changes an Agent rule: enabled false pauses it and true resumes it; dql replaces its condition (same id); label, interval_s and channels change what it says, how often it is checked and where it sends. Setting the same values again changes nothing. Change only what the user asked for; rule_id comes from agent_rule_create or agent_state. After, tell the user the rule’s status as returned. Not counted on your key.
Use this when the user wants to pause, resume or edit an alert; to remove it for good use agent_rule_delete.
| Argument | Type | Required | Meaning |
|---|---|---|---|
rule_id |
string | yes | The rule’s id, as agent_rule_create returned it or agent_state lists it. |
enabled |
boolean | false pauses the rule (it is not checked and sends nothing); true resumes it. |
|
dql |
string | The whole new condition as DQL (agent_rule_get has the current one). | |
label |
string | The alert’s name, written by the user: the first line of every notification (at most 200 characters, shown as plain text). | |
interval_s |
integer | Check interval in seconds. Default: the plan’s shortest (limits.min_interval_s of agent_channels); shorter gives PLAN_INTERVAL_TOO_SHORT. |
|
mode |
live, settled |
Execution mode. Live candle rules first attempt 15s after close; settled waits for stable history. Existing rules change only with an explicit mode selection. | |
channels |
array of string | Where the notifications go: any number of channel ids from agent_channels, mixing Telegram chats and webhooks; telegram or webhook stands for every channel of that kind. Leave it out only when the account has exactly one channel. Each channel a firing reaches counts as one of the plan’s daily notifications. |
|
fire_mode |
edge, remind |
remind also notifies every remind_every_s while true (Telegram, email). Default edge. |
|
remind_every_s |
integer | Seconds, remind mode. Default 3600. | |
notify_on_enable |
boolean | Notify once if already true when turned on. Default true for a new rule. |
Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: true.
agent_rule_delete
Section titled “agent_rule_delete”DEBYKO delete an alert rule · changes data; destructive · offered with the Agent tools on
Deletes an Agent rule: it stops at once and sends nothing more; its past firings stay at agent.debyko.com/firings. It cannot be undone: confirm with the user which rule (by its label) before calling; to stop a rule for a while, pause it with agent_rule_set instead. Not counted on your key.
Use this when the user wants an alert gone for good; to pause it use agent_rule_set with enabled: false.
| Argument | Type | Required | Meaning |
|---|---|---|---|
rule_id |
string | yes | The rule’s id, as agent_rule_create returned it or agent_state lists it. |
Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: true.
agent_set_enabled
Section titled “agent_set_enabled”DEBYKO Agent on or off · changes data; destructive · offered with the Agent tools on
Turns Agent on or off for the whole account. Off is the kill switch: no rule is checked and nothing is sent until it is on again; on resumes the rules that stopped with it. Agent is on by default: call this with enabled: true only when the user asks for it (for example after a rule came back with code AGENT_STOPPED), and with false only when the user asks to stop everything. Tell the user what changed. Not counted on your key.
Use this when the user wants every alert stopped, or Agent turned back on; for one rule use agent_rule_set.
| Argument | Type | Required | Meaning |
|---|---|---|---|
enabled |
boolean | yes | true: Agent checks the rules. false: no rule is checked until it is turned on again. |
Annotations: readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: true.
Resources
Section titled “Resources”What the server offers to read beside the tools; an AI reads them to answer “how do I use DEBYKO”.
| URI | What it is |
|---|---|
docs://getting-started |
How to open a free account, connect an AI client (claude.ai, ChatGPT, Claude Code, Cursor, any MCP client with a key), link Telegram, make a first Agent rule, find its firings and stop it, with the exact URLs and button names. |
docs://agent |
Agent at agent.debyko.com step by step: Agent on and off, New rule (lines or Edit as text, choose channels, Telegram message), edit, pause, Stop all; Channels (Connect Telegram, Add webhook, Send test, Remove); what a notification looks like, when a rule fires, statuses, limits. |
docs://plans |
Every self-serve plan with its price, venues, history, request limits and Agent limits (rules, shortest check interval, checks per minute, webhooks, Telegram chats), read from the plan table when this resource is read. |
docs://dql |
The grammar of the query language of the screen tool, of where and of Agent rules, every field and function, and ten queries that run. |
docs://layers |
The layer names used by every tool (ticker, mark, funding, oi, book, stats, venue_depth, …), what each holds, in which unit, and which tool takes which name. |
Prompts
Section titled “Prompts”Ready-made requests, in clients that show MCP prompts.
| Prompt | What it asks | Arguments |
|---|---|---|
setup |
Check the account and plan, link Telegram to Agent, then help create a first alert. | none |
alert |
Make an alert condition concrete, create it with agent_rule_create, show the dry run and how to turn it off. | instrument, condition, delivery |