ibkr-agent-gateway 0.5.2

Unofficial local-first CLI and MCP gateway for Interactive Brokers workflows.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
//! MCP handlers for explicit preview and paper order tools.

use super::tools::{
    order_preview::ORDER_PREVIEW_TOOL,
    orders_paper::{PAPER_ORDER_CANCEL_TOOL, PAPER_ORDER_MODIFY_TOOL, PAPER_ORDER_SUBMIT_TOOL},
};
use crate::cli::commands::account::parse_account_id;
use crate::internal::{
    approval::ApprovalId,
    audit::{
        OrderIdempotencyOperation, OrderIdempotencyRecoveryContext, OrderIdempotencyWorkflow,
        SqliteAuditWriter,
    },
    auth::{
        ORDERS_PAPER_CANCEL, ORDERS_PAPER_MODIFY, ORDERS_PAPER_SUBMIT, ORDERS_PREVIEW, ScopeSet,
    },
    backend::IbkrBackend,
    config::{OrderPreviewConfig, PaperTradingConfig},
    domain::{
        AccountMode, AssetClass, BrokerOrderId, CurrencyCode, ErrorCode, GatewayError, LocalUserId,
        Money, OrderContractInput, OrderIntent, OrderIntentId, OrderSide, PreviewOrderType,
        Quantity, TimeInForce,
    },
    mcp::enforce_scope,
    orders::{
        IdempotencyKey, IdempotencyStore, LocalCandidatePaperWriter, OrderModifyFields,
        PaperCancelRequest, PaperModifyRequest, PaperSubmitRequest, build_validated_order,
        cancel_paper_order, create_order_preview, handle_pending_order_error, modify_paper_order,
        stable_request_hash, submit_paper_order,
    },
    risk::{RiskDecision, RiskPolicy, validate_order_intent},
};
use rust_decimal::Decimal;
use serde::Serialize;
use serde_json::Value;
use std::str::FromStr;
use time::OffsetDateTime;

/// Server-owned dependencies for preview and paper MCP order handlers.
pub struct McpOrderWorkflowContext<'a> {
    /// Broker read backend used for contract resolution.
    pub backend: &'a dyn IbkrBackend,
    /// Durable audit and workflow state.
    pub audit_writer: &'a SqliteAuditWriter,
}

/// Dispatches one explicit preview or paper MCP order tool.
pub async fn handle_order_workflow_tool(
    context: &McpOrderWorkflowContext<'_>,
    scopes: &ScopeSet,
    tool_name: &str,
    args: &Value,
) -> Result<Value, GatewayError> {
    match tool_name {
        ORDER_PREVIEW_TOOL => handle_order_preview(context, scopes, args).await,
        PAPER_ORDER_SUBMIT_TOOL => handle_paper_submit(context, scopes, args).await,
        PAPER_ORDER_CANCEL_TOOL => handle_paper_cancel(context, scopes, args).await,
        PAPER_ORDER_MODIFY_TOOL => handle_paper_modify(context, scopes, args).await,
        _ => Err(GatewayError::new(
            ErrorCode::ReadonlyWriteForbidden,
            format!("MCP tool {tool_name} is not a preview or paper order tool"),
            false,
            Some("Use a registered preview or paper MCP tool".to_string()),
        )),
    }
}

/// Handles `ibkr_order_preview`.
pub async fn handle_order_preview(
    context: &McpOrderWorkflowContext<'_>,
    scopes: &ScopeSet,
    args: &Value,
) -> Result<Value, GatewayError> {
    enforce_scope(scopes, ORDERS_PREVIEW)?;
    let account_id = parse_account_id(arg_string(args, "account_id")?)?;
    let symbol = arg_string(args, "symbol")?;
    let side = parse_side(arg_string(args, "side")?)?;
    let quantity = parse_decimal(arg_string(args, "quantity")?, "quantity")?;
    let order_type = parse_order_type(arg_string(args, "order_type")?)?;
    ensure_literal(args, "time_in_force", "day")?;
    let currency = parse_currency(
        args.get("currency")
            .and_then(Value::as_str)
            .unwrap_or("USD"),
    )?;
    let limit_price = parse_optional_money(args, "limit_price", "limit price", &currency)?;
    let stop_price = parse_optional_money(args, "stop_price", "stop price", &currency)?;
    let trailing_amount =
        parse_optional_money(args, "trailing_amount", "trailing amount", &currency)?;
    let trailing_percent = parse_optional_decimal(args, "trailing_percent", "trailing percent")?;

    let config = OrderPreviewConfig {
        enabled: true,
        ..OrderPreviewConfig::default()
    };
    let intent = OrderIntent {
        intent_id: OrderIntentId::new(),
        account_id,
        account_mode: AccountMode::Paper,
        contract: OrderContractInput::Query {
            symbol: symbol.to_string(),
            asset_class: AssetClass::Stock,
            currency: currency.clone(),
            exchange: Some("SMART".to_string()),
        },
        side,
        quantity: Quantity::new(quantity),
        order_type,
        limit_price,
        stop_price,
        trailing_amount,
        trailing_percent,
        time_in_force: TimeInForce::Day,
        rationale: None,
        created_by: LocalUserId::from_static("mcp-local-user"),
        created_at: OffsetDateTime::now_utc(),
    };

    let policy = RiskPolicy {
        enabled: true,
        ..RiskPolicy::default()
    };
    let decision = validate_order_intent(&intent, &policy)?;
    let RiskDecision::Allow { warnings } = decision else {
        return Err(GatewayError::new(
            ErrorCode::OrderPolicyRefused,
            "Order preview was refused by deterministic risk policy",
            false,
            Some("Inspect risk refusal details".to_string()),
        ));
    };

    let contract = context.backend.resolve_contract(symbol).await?;
    let validated = build_validated_order(
        &intent,
        &contract,
        warnings
            .into_iter()
            .map(|warning| warning.message)
            .collect(),
        config.preview_expiration_seconds,
    )?;
    let preview = create_order_preview(
        &validated,
        crate::internal::domain::AuditEventId::new(),
        None,
        None,
    )?;
    context
        .audit_writer
        .append_order_preview(&preview, &validated)
        .await?;
    serde_json::to_value(preview).map_err(output_error)
}

/// Handles `ibkr_paper_order_submit`.
pub async fn handle_paper_submit(
    context: &McpOrderWorkflowContext<'_>,
    scopes: &ScopeSet,
    args: &Value,
) -> Result<Value, GatewayError> {
    enforce_scope(scopes, ORDERS_PAPER_SUBMIT)?;
    let account_id = parse_account_id(arg_string(args, "account_id")?)?;
    let approval_id = ApprovalId::parse(arg_string(args, "approval_id")?)?;
    let approval = context
        .audit_writer
        .load_approval(&approval_id)
        .await?
        .ok_or_else(missing_approval)?;
    let preview_record = context
        .audit_writer
        .load_order_preview(&approval.preview_id)
        .await?
        .ok_or_else(missing_preview)?;
    let idempotency_key = IdempotencyKey::new(arg_string(args, "idempotency_key")?)?;
    let request_hash = stable_request_hash(
        "mcp.paper.submit",
        &PaperSubmitMcpFingerprint {
            account_id: account_id.as_str(),
            approval_id: approval_id.as_uuid().to_string(),
        },
    )?;
    if let Some(payload) = context
        .audit_writer
        .replay_order_idempotency(&idempotency_key, &request_hash)
        .await?
    {
        return Ok(payload);
    }

    let request = PaperSubmitRequest {
        order: preview_record.validated_order,
        approval,
        idempotency_key: idempotency_key.clone(),
        paper_config: PaperTradingConfig {
            enabled: true,
            allowed_accounts: vec![account_id],
        },
    };
    let recovery_context = OrderIdempotencyRecoveryContext {
        workflow: OrderIdempotencyWorkflow::Paper,
        operation: OrderIdempotencyOperation::Submit,
        account_id: request.order.account_id.clone(),
        broker_order_id: None,
    };
    context
        .audit_writer
        .insert_order_pending_with_context(&idempotency_key, &request_hash, Some(&recovery_context))
        .await?;

    let mut idempotency_store = IdempotencyStore::default();
    let result =
        match submit_paper_order(request, &LocalCandidatePaperWriter, &mut idempotency_store).await
        {
            Ok(result) => result,
            Err(error) => {
                handle_pending_order_error(
                    context.audit_writer,
                    &idempotency_key,
                    &request_hash,
                    &error,
                )
                .await?;
                return Err(error);
            }
        };
    let payload = serde_json::to_value(&result.lifecycle).map_err(output_error)?;
    context
        .audit_writer
        .complete_order_workflow(
            &idempotency_key,
            &request_hash,
            &payload,
            std::slice::from_ref(&result.consumed_approval),
        )
        .await?;
    Ok(payload)
}

/// Handles `ibkr_paper_order_cancel`.
pub async fn handle_paper_cancel(
    context: &McpOrderWorkflowContext<'_>,
    scopes: &ScopeSet,
    args: &Value,
) -> Result<Value, GatewayError> {
    enforce_scope(scopes, ORDERS_PAPER_CANCEL)?;
    let account_id = parse_account_id(arg_string(args, "account_id")?)?;
    let broker_order_id = parse_broker_order_id(arg_string(args, "broker_order_id")?)?;
    let idempotency_key = IdempotencyKey::new(arg_string(args, "idempotency_key")?)?;
    let request_hash = stable_request_hash(
        "mcp.paper.cancel",
        &PaperCancelMcpFingerprint {
            account_id: account_id.as_str(),
            broker_order_id: broker_order_id.as_str(),
        },
    )?;
    if let Some(payload) = context
        .audit_writer
        .replay_order_idempotency(&idempotency_key, &request_hash)
        .await?
    {
        return Ok(payload);
    }

    let request = PaperCancelRequest {
        account_id: account_id.clone(),
        broker_order_id: broker_order_id.clone(),
        idempotency_key: idempotency_key.clone(),
        paper_config: PaperTradingConfig {
            enabled: true,
            allowed_accounts: vec![account_id],
        },
    };
    let recovery_context = OrderIdempotencyRecoveryContext {
        workflow: OrderIdempotencyWorkflow::Paper,
        operation: OrderIdempotencyOperation::Cancel,
        account_id: request.account_id.clone(),
        broker_order_id: Some(broker_order_id),
    };
    context
        .audit_writer
        .insert_order_pending_with_context(&idempotency_key, &request_hash, Some(&recovery_context))
        .await?;

    let mut idempotency_store = IdempotencyStore::default();
    let result =
        match cancel_paper_order(request, &LocalCandidatePaperWriter, &mut idempotency_store).await
        {
            Ok(result) => result,
            Err(error) => {
                handle_pending_order_error(
                    context.audit_writer,
                    &idempotency_key,
                    &request_hash,
                    &error,
                )
                .await?;
                return Err(error);
            }
        };
    let payload = serde_json::to_value(&result.lifecycle).map_err(output_error)?;
    context
        .audit_writer
        .insert_order_idempotency(&idempotency_key, &request_hash, &payload)
        .await?;
    Ok(payload)
}

/// Handles `ibkr_paper_order_modify`.
pub async fn handle_paper_modify(
    context: &McpOrderWorkflowContext<'_>,
    scopes: &ScopeSet,
    args: &Value,
) -> Result<Value, GatewayError> {
    enforce_scope(scopes, ORDERS_PAPER_MODIFY)?;
    let account_id = parse_account_id(arg_string(args, "account_id")?)?;
    let broker_order_id = parse_broker_order_id(arg_string(args, "broker_order_id")?)?;
    let idempotency_key = IdempotencyKey::new(arg_string(args, "idempotency_key")?)?;
    let changes = parse_modify_fields(args)?;
    let request_hash = stable_request_hash(
        "mcp.paper.modify",
        &PaperModifyMcpFingerprint {
            account_id: account_id.as_str(),
            broker_order_id: broker_order_id.as_str(),
            changes: &changes,
        },
    )?;
    if let Some(payload) = context
        .audit_writer
        .replay_order_idempotency(&idempotency_key, &request_hash)
        .await?
    {
        return Ok(payload);
    }

    let request = PaperModifyRequest {
        account_id: account_id.clone(),
        broker_order_id: broker_order_id.clone(),
        changes,
        idempotency_key: idempotency_key.clone(),
        paper_config: PaperTradingConfig {
            enabled: true,
            allowed_accounts: vec![account_id],
        },
    };
    let recovery_context = OrderIdempotencyRecoveryContext {
        workflow: OrderIdempotencyWorkflow::Paper,
        operation: OrderIdempotencyOperation::Modify,
        account_id: request.account_id.clone(),
        broker_order_id: Some(broker_order_id),
    };
    context
        .audit_writer
        .insert_order_pending_with_context(&idempotency_key, &request_hash, Some(&recovery_context))
        .await?;

    let mut idempotency_store = IdempotencyStore::default();
    let result =
        match modify_paper_order(request, &LocalCandidatePaperWriter, &mut idempotency_store).await
        {
            Ok(result) => result,
            Err(error) => {
                handle_pending_order_error(
                    context.audit_writer,
                    &idempotency_key,
                    &request_hash,
                    &error,
                )
                .await?;
                return Err(error);
            }
        };
    let payload = serde_json::to_value(&result.lifecycle).map_err(output_error)?;
    context
        .audit_writer
        .insert_order_idempotency(&idempotency_key, &request_hash, &payload)
        .await?;
    Ok(payload)
}

#[derive(Serialize)]
struct PaperSubmitMcpFingerprint<'a> {
    account_id: &'a str,
    approval_id: String,
}

#[derive(Serialize)]
struct PaperCancelMcpFingerprint<'a> {
    account_id: &'a str,
    broker_order_id: &'a str,
}

#[derive(Serialize)]
struct PaperModifyMcpFingerprint<'a> {
    account_id: &'a str,
    broker_order_id: &'a str,
    changes: &'a OrderModifyFields,
}

fn arg_string<'a>(args: &'a Value, key: &str) -> Result<&'a str, GatewayError> {
    args.get(key)
        .and_then(Value::as_str)
        .filter(|value| !value.trim().is_empty())
        .ok_or_else(|| {
            GatewayError::new(
                ErrorCode::ConfigInvalid,
                format!("Missing MCP argument: {key}"),
                false,
                Some("Send a valid MCP tools/call request".to_string()),
            )
        })
}

fn parse_decimal(value: &str, label: &str) -> Result<Decimal, GatewayError> {
    Decimal::from_str(value).map_err(|_| {
        GatewayError::new(
            ErrorCode::OrderValidationFailed,
            format!("Invalid decimal {label}"),
            false,
            Some(format!("Provide a valid decimal {label}")),
        )
    })
}

fn parse_side(value: &str) -> Result<OrderSide, GatewayError> {
    match value {
        "buy" => Ok(OrderSide::Buy),
        "sell" => Ok(OrderSide::Sell),
        _ => Err(GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Side must be buy or sell",
            false,
            Some("Use side buy or sell".to_string()),
        )),
    }
}

fn parse_order_type(value: &str) -> Result<PreviewOrderType, GatewayError> {
    match value {
        "limit" => Ok(PreviewOrderType::Limit),
        "market" => Ok(PreviewOrderType::Market),
        "stop" => Ok(PreviewOrderType::Stop),
        "stop_limit" | "stop-limit" => Ok(PreviewOrderType::StopLimit),
        "trailing_stop" | "trailing-stop" => Ok(PreviewOrderType::TrailingStop),
        _ => Err(GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Unsupported order type",
            false,
            Some("Use limit, market, stop, stop_limit, or trailing_stop".to_string()),
        )),
    }
}

fn parse_optional_decimal(
    args: &Value,
    key: &str,
    label: &str,
) -> Result<Option<Decimal>, GatewayError> {
    args.get(key)
        .and_then(Value::as_str)
        .map(|value| parse_decimal(value, label))
        .transpose()
}

fn parse_optional_money(
    args: &Value,
    key: &str,
    label: &str,
    currency: &CurrencyCode,
) -> Result<Option<Money>, GatewayError> {
    parse_optional_decimal(args, key, label).map(|amount| {
        amount.map(|amount| Money {
            amount,
            currency: currency.clone(),
        })
    })
}

pub(crate) fn parse_modify_fields(args: &Value) -> Result<OrderModifyFields, GatewayError> {
    let currency = parse_currency(
        args.get("currency")
            .and_then(Value::as_str)
            .unwrap_or("USD"),
    )?;
    let quantity = parse_optional_decimal(args, "quantity", "quantity")?.map(Quantity::new);
    let time_in_force = args
        .get("time_in_force")
        .and_then(Value::as_str)
        .map(parse_time_in_force)
        .transpose()?;
    let fields = OrderModifyFields {
        quantity,
        limit_price: parse_optional_money(args, "limit_price", "limit price", &currency)?,
        stop_price: parse_optional_money(args, "stop_price", "stop price", &currency)?,
        time_in_force,
        trailing_amount: parse_optional_money(
            args,
            "trailing_amount",
            "trailing amount",
            &currency,
        )?,
        trailing_percent: parse_optional_decimal(args, "trailing_percent", "trailing percent")?,
    };
    fields.validate()?;
    if !fields.has_changes() {
        return Err(GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Order modify requires at least one bounded change",
            false,
            Some("Provide quantity, price, time-in-force, or trailing changes".to_string()),
        ));
    }
    Ok(fields)
}

fn parse_time_in_force(value: &str) -> Result<TimeInForce, GatewayError> {
    match value {
        "day" => Ok(TimeInForce::Day),
        "gtc" | "good_till_cancelled" | "good-till-cancelled" => Ok(TimeInForce::GoodTillCancelled),
        _ => Err(GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Unsupported time-in-force",
            false,
            Some("Use day or gtc".to_string()),
        )),
    }
}

fn parse_currency(value: &str) -> Result<CurrencyCode, GatewayError> {
    CurrencyCode::new(value).ok_or_else(|| {
        GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Currency must be a three-letter code",
            false,
            Some("Use a valid ISO currency code".to_string()),
        )
    })
}

fn parse_broker_order_id(value: &str) -> Result<BrokerOrderId, GatewayError> {
    BrokerOrderId::new(value).ok_or_else(|| {
        GatewayError::new(
            ErrorCode::OrderValidationFailed,
            "Broker order id is required",
            false,
            Some("Provide a broker order id".to_string()),
        )
    })
}

fn ensure_literal(args: &Value, key: &str, expected: &str) -> Result<(), GatewayError> {
    let value = arg_string(args, key)?;
    if value.eq_ignore_ascii_case(expected) {
        return Ok(());
    }
    Err(GatewayError::new(
        ErrorCode::OrderValidationFailed,
        format!("{key} must be {expected}"),
        false,
        Some(format!("Use {key}: {expected}")),
    ))
}

fn missing_approval() -> GatewayError {
    GatewayError::new(
        ErrorCode::PaperApprovalRequired,
        "Paper submit requires an existing approval record",
        false,
        Some("Create an approval and pass its approval_id".to_string()),
    )
}

fn missing_preview() -> GatewayError {
    GatewayError::new(
        ErrorCode::PaperApprovalRequired,
        "Paper submit requires the approved preview to be present",
        false,
        Some("Create a fresh preview and approval before paper submit".to_string()),
    )
}

fn output_error(_error: serde_json::Error) -> GatewayError {
    GatewayError::new(
        ErrorCode::OutputUnsafe,
        "Failed to serialize MCP order workflow result",
        false,
        Some("Retry the MCP request".to_string()),
    )
}