solverforge-cli 3.3.2

CLI for scaffolding and managing SolverForge constraint solver projects
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
use std::sync::Arc;

use rmcp::handler::server::router::tool::ToolRouter;
use rmcp::handler::server::wrapper::{Json, Parameters};
use rmcp::model::{
    CallToolRequestParams, CallToolResponse, CancelTaskParams, CreateTaskResult, GetTaskParams,
    GetTaskResult, Implementation, MetaObject, ServerCapabilities, ServerInfo, UpdateTaskParams,
};
use rmcp::service::RequestContext;
use rmcp::task_manager::TaskManager;
use rmcp::RoleServer;
use rmcp::{tool, tool_handler, tool_router, ErrorData, ServerHandler};
use schemars::JsonSchema;
use serde::Deserialize;

use crate::api::dto::{
    analysis_response, JobAnalysisDto, JobSnapshotDto, JobSummaryDto, JobTelemetryDetailDto,
    PlanDto,
};
use crate::api::telemetry::CandidateTraceDto;
use crate::data::{generate, DemoData};
use crate::solver::SolverService;

use super::dto::SolveResultDto;
use super::tasks;

/// Input for `solve`: a full plan or a demo data size, never both.
#[derive(Debug, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct SolveRequest {
    /// Complete plan instance to optimize.
    pub plan: Option<PlanDto>,
    /// Demo data size to optimize instead of a plan (small, standard, or large).
    pub demo: Option<String>,
}

#[derive(Debug, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct JobRequest {
    /// Retained solver job identifier.
    pub job_id: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct SnapshotRequest {
    /// Retained solver job identifier.
    pub job_id: String,
    /// Specific snapshot revision; omit for the latest retained snapshot.
    pub snapshot_revision: Option<u64>,
}

#[derive(Debug, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct DemoDataRequest {
    /// Demo data size (small, standard, or large).
    pub demo: String,
}

#[derive(Debug, schemars::JsonSchema, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct JobOpResult {
    /// Retained solver job identifier.
    pub job_id: String,
    /// Whether the runtime accepted the operation.
    pub accepted: bool,
}

/// MCP delivery surface for this planning application. The handler projects
/// the retained solver job lifecycle onto agent-facing tools: task-capable
/// clients receive a task handle for `solve`, every other client receives an
/// immediate job summary and drives the lifecycle through the polling tools.
pub struct SolverMcp {
    tool_router: ToolRouter<Self>,
    tasks: TaskManager,
    solver: Arc<SolverService>,
}

impl SolverMcp {
    pub fn new(solver: Arc<SolverService>, tasks: TaskManager) -> Self {
        Self {
            tool_router: Self::tool_router(),
            tasks,
            solver,
        }
    }

    fn start_from_request(&self, request: SolveRequest) -> Result<String, ErrorData> {
        match (request.plan, request.demo) {
            (Some(plan), None) => {
                let domain = plan.to_domain().map_err(|error| {
                    ErrorData::invalid_params(format!("invalid plan: {error}"), None)
                })?;
                self.solver.start_job(domain).map_err(solver_error)
            }
            (None, Some(demo)) => {
                let size: DemoData = demo.parse().map_err(|_| {
                    ErrorData::invalid_params(format!("unknown demo data size '{demo}'"), None)
                })?;
                self.solver.start_job(generate(size)).map_err(solver_error)
            }
            (Some(_), Some(_)) | (None, None) => Err(ErrorData::invalid_params(
                "provide exactly one of `plan` or `demo`",
                None,
            )),
        }
    }

    fn job_summary(&self, job_id: &str) -> Result<JobSummaryDto, ErrorData> {
        let status = self.solver.get_status(job_id).map_err(solver_error)?;
        let numeric_id = parse_job_id(job_id)?;
        Ok(JobSummaryDto::from_status(numeric_id, &status))
    }

    fn solve_result(&self, job_id: &str) -> Result<SolveResultDto, ErrorData> {
        let status = self.solver.get_status(job_id).map_err(solver_error)?;
        let numeric_id = parse_job_id(job_id)?;
        Ok(SolveResultDto::from_status(numeric_id, &status))
    }
}

#[tool_router]
impl SolverMcp {
    #[tool(
        description = "Start a retained solver job. Returns an MCP task handle when the client negotiates task support, otherwise returns the job summary immediately and the job is driven through the polling tools.",
        annotations(
            title = "Solve",
            read_only_hint = false,
            destructive_hint = false,
            idempotent_hint = false,
            open_world_hint = false
        )
    )]
    fn solve(
        &self,
        Parameters(request): Parameters<SolveRequest>,
    ) -> Result<Json<SolveResultDto>, ErrorData> {
        let job_id = self.start_from_request(request)?;
        Ok(Json(self.solve_result(&job_id)?))
    }

    #[tool(
        description = "List the available demo data sizes for this planning application.",
        annotations(
            title = "List demo data",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn list_demo_data(&self) -> Json<Vec<String>> {
        Json(
            DemoData::available_demo_data()
                .iter()
                .map(|demo| demo.id().to_string())
                .collect(),
        )
    }

    #[tool(
        description = "Return the generated plan instance for one demo data size.",
        annotations(
            title = "Get demo data",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn get_demo_data(
        &self,
        Parameters(request): Parameters<DemoDataRequest>,
    ) -> Result<Json<PlanDto>, ErrorData> {
        let size: DemoData = request.demo.parse().map_err(|_| {
            ErrorData::invalid_params(format!("unknown demo data size '{}'", request.demo), None)
        })?;
        Ok(Json(PlanDto::from_plan(&generate(size))))
    }

    #[tool(
        description = "Return the live status of a retained solver job, including the complete compact telemetry aggregate.",
        annotations(
            title = "Job status",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn get_status(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobSummaryDto>, ErrorData> {
        Ok(Json(self.job_summary(&request.job_id)?))
    }

    #[tool(
        description = "Return the best solution snapshot of a retained solver job.",
        annotations(
            title = "Best solution",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn get_best_solution(
        &self,
        Parameters(request): Parameters<SnapshotRequest>,
    ) -> Result<Json<JobSnapshotDto>, ErrorData> {
        let snapshot = self
            .solver
            .get_snapshot(&request.job_id, request.snapshot_revision)
            .map_err(solver_error)?;
        Ok(Json(JobSnapshotDto::from_snapshot(&snapshot)))
    }

    #[tool(
        description = "Return the snapshot-bound score analysis of a retained solver job, broken down per constraint.",
        annotations(
            title = "Analyze solution",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn analyze_solution(
        &self,
        Parameters(request): Parameters<SnapshotRequest>,
    ) -> Result<Json<JobAnalysisDto>, ErrorData> {
        let snapshot_analysis = self
            .solver
            .analyze_snapshot(&request.job_id, request.snapshot_revision)
            .map_err(solver_error)?;
        let analysis = analysis_response(&snapshot_analysis.analysis);
        Ok(Json(JobAnalysisDto::from_snapshot_analysis(
            &snapshot_analysis,
            analysis,
        )))
    }

    #[tool(
        description = "Return the retained status telemetry of a solver job, including bounded candidate pulls when candidate tracing is enabled.",
        annotations(
            title = "Job telemetry",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn get_telemetry(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobTelemetryDetailDto>, ErrorData> {
        let detail = self
            .solver
            .get_telemetry_detail(&request.job_id)
            .map_err(solver_error)?;
        Ok(Json(JobTelemetryDetailDto::from_runtime(&detail)))
    }

    #[tool(
        description = "Return only the bounded, retained candidate-pull trace of a solver job. Empty unless candidate tracing is enabled through candidate_trace.max_entries.",
        annotations(
            title = "Candidate trace",
            read_only_hint = true,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn get_candidate_trace(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<Option<CandidateTraceDto>>, ErrorData> {
        let detail = self
            .solver
            .get_telemetry_detail(&request.job_id)
            .map_err(solver_error)?;
        Ok(Json(
            detail
                .candidate_trace
                .as_ref()
                .map(CandidateTraceDto::from_runtime),
        ))
    }

    #[tool(
        description = "Pause a running solver job. Resume with the resume tool; the runtime continues from the retained checkpoint.",
        annotations(
            title = "Pause job",
            read_only_hint = false,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn pause(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobOpResult>, ErrorData> {
        let accepted = self.solver.pause(&request.job_id).is_ok();
        Ok(Json(JobOpResult {
            job_id: request.job_id,
            accepted,
        }))
    }

    #[tool(
        description = "Resume a paused solver job from its retained checkpoint.",
        annotations(
            title = "Resume job",
            read_only_hint = false,
            destructive_hint = false,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn resume(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobOpResult>, ErrorData> {
        let accepted = self.solver.resume(&request.job_id).is_ok();
        Ok(Json(JobOpResult {
            job_id: request.job_id,
            accepted,
        }))
    }

    #[tool(
        description = "Cancel a solver job. The best solution found so far stays retained and readable.",
        annotations(
            title = "Cancel job",
            read_only_hint = false,
            destructive_hint = true,
            idempotent_hint = true,
            open_world_hint = false
        )
    )]
    fn cancel(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobOpResult>, ErrorData> {
        let accepted = self.solver.cancel(&request.job_id).is_ok();
        Ok(Json(JobOpResult {
            job_id: request.job_id,
            accepted,
        }))
    }

    #[tool(
        description = "Delete a terminal solver job and its retained artifacts. This is irreversible cleanup and the only way to remove terminal jobs.",
        annotations(
            title = "Delete job",
            read_only_hint = false,
            destructive_hint = true,
            idempotent_hint = false,
            open_world_hint = false
        )
    )]
    fn delete(
        &self,
        Parameters(request): Parameters<JobRequest>,
    ) -> Result<Json<JobOpResult>, ErrorData> {
        let accepted = self.solver.delete(&request.job_id).is_ok();
        Ok(Json(JobOpResult {
            job_id: request.job_id,
            accepted,
        }))
    }
}

#[tool_handler]
impl ServerHandler for SolverMcp {
    fn get_info(&self) -> ServerInfo {
        ServerInfo::new(
            ServerCapabilities::builder()
                .enable_tools()
                .enable_tasks()
                .build(),
        )
        .with_server_info(Implementation::new(
            env!("CARGO_PKG_NAME"),
            env!("CARGO_PKG_VERSION"),
        ))
        .with_instructions(concat!(
            "SolverForge planning server. Solve optimization problems over demo data or ",
            "full plan instances, inspect live status, telemetry, and score analysis, ",
            "and drive the retained job lifecycle: pause, resume, cancel, and delete."
        ))
    }

    async fn call_tool(
        &self,
        request: CallToolRequestParams,
        context: RequestContext<RoleServer>,
    ) -> Result<CallToolResponse, ErrorData> {
        tracing::info!(tool = %request.name, "mcp tool invocation");

        let client_supports_tasks = context
            .client_capabilities()
            .is_some_and(|caps| caps.supports_tasks());

        if request.name == "solve" && client_supports_tasks {
            let solve_request: SolveRequest = match &request.arguments {
                Some(arguments) => {
                    serde_json::from_value(arguments.clone().into()).map_err(|error| {
                        ErrorData::invalid_params(format!("invalid solve request: {error}"), None)
                    })?
                }
                None => SolveRequest {
                    plan: None,
                    demo: None,
                },
            };
            let job_id = self.start_from_request(solve_request)?;
            let mut task_meta = serde_json::Map::new();
            task_meta.insert(
                "jobId".to_string(),
                serde_json::Value::String(job_id.clone()),
            );
            let task = tasks::spawn_solve_task(
                &self.tasks,
                Arc::clone(&self.solver),
                context.peer.clone(),
                context.meta.get_progress_token(),
                job_id,
            );
            return Ok(CallToolResponse::Task(
                CreateTaskResult::new(task).with_meta(MetaObject(task_meta)),
            ));
        }

        let tool_context =
            rmcp::handler::server::tool::ToolCallContext::new(self, request, context);
        self.tool_router.call(tool_context).await
    }

    async fn get_task(
        &self,
        request: GetTaskParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<GetTaskResult, ErrorData> {
        Ok(GetTaskResult::new(self.tasks.get_task(&request.task_id)?))
    }

    async fn update_task(
        &self,
        request: UpdateTaskParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<(), ErrorData> {
        self.tasks
            .update_task(&request.task_id, request.input_responses)
    }

    async fn cancel_task(
        &self,
        request: CancelTaskParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<(), ErrorData> {
        // Cancellation is cooperative: the solve watcher observes the task
        // cancellation and cancels the underlying solver job.
        self.tasks.cancel_task(&request.task_id)
    }
}

fn parse_job_id(job_id: &str) -> Result<usize, ErrorData> {
    job_id
        .parse::<usize>()
        .map_err(|_| ErrorData::invalid_params(format!("invalid job id '{job_id}'"), None))
}

fn solver_error(error: solverforge::SolverManagerError) -> ErrorData {
    let message = error.to_string();
    match error {
        solverforge::SolverManagerError::JobNotFound { .. }
        | solverforge::SolverManagerError::SnapshotNotFound { .. } => {
            ErrorData::invalid_params(message, None)
        }
        solverforge::SolverManagerError::NoFreeJobSlots => ErrorData::internal_error(message, None),
        solverforge::SolverManagerError::InvalidStateTransition { .. }
        | solverforge::SolverManagerError::NoSnapshotAvailable { .. } => {
            ErrorData::invalid_params(message, None)
        }
    }
}