algocline_core/engine_api.rs
1use async_trait::async_trait;
2
3// ─── Parameter types (transport-independent) ─────────────────────
4
5/// A single query response in a batch feed.
6#[derive(Debug)]
7pub struct QueryResponse {
8 /// Query ID (e.g. "q-0", "q-1").
9 pub query_id: String,
10 /// The host LLM's response for this query.
11 pub response: String,
12 /// Token usage reported by the host for this query.
13 pub usage: Option<crate::TokenUsage>,
14}
15
16// ─── Engine API trait ────────────────────────────────────────────
17
18/// Transport-independent API for the algocline engine.
19///
20/// Abstracts the full public surface of AppService so that callers
21/// (MCP handler, future daemon client, etc.) can operate through
22/// `Arc<dyn EngineApi>` without depending on the concrete implementation.
23///
24/// All methods are async to support both local (in-process) and remote
25/// (socket/HTTP) implementations uniformly.
26#[async_trait]
27pub trait EngineApi: Send + Sync {
28 // ─── Core execution ──────────────────────────────────────
29
30 /// Execute Lua code with optional JSON context.
31 ///
32 /// When `host_mode: Some(true)` is passed, the call is proxied via
33 /// `PoolClient` to a long-lived worker subprocess over a Unix domain socket.
34 /// When `host_mode` is `None` or `Some(false)` the existing in-process
35 /// `Executor::start_session` path is used unchanged.
36 async fn run(
37 &self,
38 code: Option<String>,
39 code_file: Option<String>,
40 ctx: Option<serde_json::Value>,
41 project_root: Option<String>,
42 host_mode: Option<bool>,
43 ) -> Result<String, String>;
44
45 /// Apply an installed strategy package. Task is optional.
46 async fn advice(
47 &self,
48 strategy: &str,
49 task: Option<String>,
50 opts: Option<serde_json::Value>,
51 project_root: Option<String>,
52 ) -> Result<String, String>;
53
54 /// Continue a paused execution — single response (with optional query_id).
55 async fn continue_single(
56 &self,
57 session_id: &str,
58 response: String,
59 query_id: Option<&str>,
60 usage: Option<crate::TokenUsage>,
61 ) -> Result<String, String>;
62
63 /// Continue a paused execution — batch feed.
64 async fn continue_batch(
65 &self,
66 session_id: &str,
67 responses: Vec<QueryResponse>,
68 ) -> Result<String, String>;
69
70 // ─── Session status ──────────────────────────────────────
71
72 /// Query active session status.
73 ///
74 /// `pending_filter` is a free-form JSON value forwarded from MCP
75 /// callers, decoded inside the app layer into either a preset name
76 /// (`"meta"` / `"preview"` / `"full"`) or a custom field-filter
77 /// object. `None` keeps the legacy count-only snapshot.
78 ///
79 /// `include_history`: when `true`, each session snapshot includes
80 /// `conversation_history` (capped at 10 entries). Default `false`
81 /// preserves the lightweight snapshot contract for high-frequency pollers.
82 async fn status(
83 &self,
84 session_id: Option<&str>,
85 pending_filter: Option<serde_json::Value>,
86 include_history: bool,
87 ) -> Result<String, String>;
88
89 // ─── Evaluation ──────────────────────────────────────────
90
91 /// Run an evalframe evaluation suite.
92 ///
93 /// `auto_card`: when true, emit an immutable Card
94 /// (`~/.algocline/cards/{strategy}/{card_id}.toml`) summarizing the run.
95 async fn eval(
96 &self,
97 scenario: Option<String>,
98 scenario_file: Option<String>,
99 scenario_name: Option<String>,
100 strategy: &str,
101 strategy_opts: Option<serde_json::Value>,
102 auto_card: bool,
103 ) -> Result<String, String>;
104
105 /// List eval history, optionally filtered by strategy.
106 async fn eval_history(&self, strategy: Option<&str>, limit: usize) -> Result<String, String>;
107
108 /// View a specific eval result by ID.
109 async fn eval_detail(&self, eval_id: &str) -> Result<String, String>;
110
111 /// Compare two eval results with statistical significance testing.
112 async fn eval_compare(&self, eval_id_a: &str, eval_id_b: &str) -> Result<String, String>;
113
114 // ─── Scenarios ───────────────────────────────────────────
115
116 /// List available scenarios.
117 async fn scenario_list(&self) -> Result<String, String>;
118
119 /// Show the content of a named scenario.
120 async fn scenario_show(&self, name: &str) -> Result<String, String>;
121
122 /// Install scenarios from a Git URL or local path.
123 async fn scenario_install(&self, url: String) -> Result<String, String>;
124
125 // ─── Packages ────────────────────────────────────────────
126
127 /// Link a local directory as a project-local package (symlink to cache).
128 ///
129 /// Scope selection:
130 /// - `scope = None` or `Some("global")` — symlink into `~/.algocline/packages/`
131 /// (visible to all projects).
132 /// - `scope = Some("variant")` — record the path in `alc.local.toml`
133 /// at the project root (worktree-scoped override, git-ignored). No
134 /// symlink is created.
135 /// - Any other value → `Err("invalid scope: ...")`.
136 ///
137 /// `project_root` is only consulted when `scope = Some("variant")`.
138 /// If `None`, falls back to `ALC_PROJECT_ROOT` env or ancestor walk
139 /// from cwd.
140 async fn pkg_link(
141 &self,
142 path: String,
143 name: Option<String>,
144 force: Option<bool>,
145 scope: Option<String>,
146 project_root: Option<String>,
147 ) -> Result<String, String>;
148
149 /// List installed packages with metadata.
150 ///
151 /// When `project_root` is provided, project-local packages from `alc.toml`/`alc.lock`
152 /// are included with `scope: "project"`. Global packages carry `scope: "global"`.
153 ///
154 /// Mirrors the list-tool knob contract used by [`Self::hub_search`]
155 /// (plan.md §4.1). Parameters are individual JSON-primitive
156 /// `Option<T>` values so the `algocline-core` crate stays free of
157 /// `algocline-app`-internal types; the impl folds them into its
158 /// `pub(crate) ListOpts` struct.
159 ///
160 /// - `limit` is `Option<i32>` at this layer (MCP/JSON boundary).
161 /// The impl clamps negative values to 0 and casts to `usize`.
162 /// `Some(0)` (and thus clamped negatives) means **no limit**
163 /// (return all entries — empty-means-all idiom); `None` falls
164 /// back to the tool's default cap.
165 /// - `filter` is a free-form JSON object; it is `Deserialize`d into
166 /// a `HashMap<String, Value>` inside the app layer. Non-object
167 /// values are logged via `tracing::warn` and treated as no filter.
168 /// - `fields` / `verbose` drive projection on each entry of the
169 /// `packages` array; `fields` wins when both are supplied.
170 /// - Top-level keys (`packages`, `search_paths`, `project_root`,
171 /// `lockfile_path`) are never projected away.
172 #[allow(clippy::too_many_arguments)]
173 async fn pkg_list(
174 &self,
175 project_root: Option<String>,
176 limit: Option<i32>,
177 sort: Option<String>,
178 filter: Option<serde_json::Value>,
179 fields: Option<Vec<String>>,
180 verbose: Option<String>,
181 ) -> Result<String, String>;
182
183 /// Install a package from a Git URL or local path.
184 ///
185 /// `force` (optional, default `false`): Collection mode only — overwrite existing
186 /// packages at dest. Single mode rejects pre-existing dest with an error regardless.
187 async fn pkg_install(
188 &self,
189 url: String,
190 name: Option<String>,
191 force: Option<bool>,
192 ) -> Result<String, String>;
193
194 /// Remove a symlinked package from `~/.algocline/packages/`.
195 ///
196 /// Only removes symlinks; for installed (copied) packages, use `pkg_remove`.
197 async fn pkg_unlink(&self, name: String) -> Result<String, String>;
198
199 /// Remove a package entry, scoped by `scope` (`"project"` /
200 /// `"global"` / `"all"`, default `"project"`).
201 ///
202 /// - `"project"`: remove from `alc.toml` + `alc.lock`. Requires an
203 /// `alc.toml` via `project_root` or ancestor walk.
204 /// - `"global"`: remove from `~/.algocline/installed.json` only.
205 /// `project_root` is ignored.
206 /// - `"all"`: remove from both; succeeds if either scope had the entry.
207 ///
208 /// Physical files in `~/.algocline/packages/{name}/` are never deleted.
209 async fn pkg_remove(
210 &self,
211 name: &str,
212 project_root: Option<String>,
213 version: Option<String>,
214 scope: Option<String>,
215 ) -> Result<String, String>;
216
217 /// Heal broken package state by reinstalling entries whose installed
218 /// directory is missing. Other broken kinds (dangling symlink,
219 /// declared-path missing) are surfaced as `unrepairable` with a
220 /// suggested remediation.
221 async fn pkg_repair(
222 &self,
223 name: Option<String>,
224 project_root: Option<String>,
225 ) -> Result<String, String>;
226
227 /// Diagnose package state without side effects.
228 ///
229 /// Read-only counterpart of [`Self::pkg_repair`]. Classifies packages
230 /// into four buckets — `healthy`, `installed_missing`, `symlink_dangling`,
231 /// `path_missing` — and returns the result as a JSON string. No
232 /// filesystem writes, no `pkg_install` calls.
233 ///
234 /// `name` restricts the report to a single package; `None` inspects
235 /// every known package. `project_root` is used for the `alc.toml` /
236 /// `alc.local.toml` pass (falls back to ancestor walk from cwd).
237 async fn pkg_doctor(
238 &self,
239 name: Option<String>,
240 project_root: Option<String>,
241 ) -> Result<String, String>;
242
243 /// Run mlua-lspec tests for a package, a single file, or inline code.
244 ///
245 /// Exactly one of `pkg`, `code_file`, or `code` must be provided; providing
246 /// zero or more than one returns a typed `Err`.
247 ///
248 /// # Arguments
249 ///
250 /// * `pkg` — installed package name; spec files are discovered under
251 /// `<pkg_root>/<spec_dir>/*_spec.lua` (default `spec_dir = "spec"`).
252 /// * `code_file` — absolute path to a single `.lua` test file.
253 /// * `code` — inline Lua source code containing lspec tests.
254 /// * `spec_dir` — subdirectory within the package root that holds spec files
255 /// (default `"spec"`). Only used when `pkg` is provided.
256 /// * `filter` — substring filter applied to spec file stems (only when `pkg`
257 /// is provided).
258 /// * `search_paths` — additional directories prepended to `package.path`
259 /// inside the Lua VM.
260 /// * `project_root` — optional project root for variant-scope package
261 /// resolution (`alc.local.toml`). Falls back to ancestor walk from cwd.
262 ///
263 /// # Returns
264 ///
265 /// On success: JSON string `{passed, failed, pending, total, duration_ms,
266 /// spec_files: [{path, passed, failed, total, duration_ms, tests: [{suite,
267 /// name, passed, pending, error}]}]}`.
268 ///
269 /// # Errors
270 ///
271 /// * Zero or multiple input sources provided → `"pkg_test: provide exactly
272 /// one of pkg, code_file, code"`.
273 /// * `pkg` not found → `"pkg_test: package '<name>' not found …"`.
274 /// * No spec files found → `"pkg_test: no spec files found in <path> …"`.
275 /// * mlua VM init failure, I/O errors, or `spawn_blocking` panic → typed
276 /// `Err` string.
277 // 8 parameters exceed clippy's default limit of 7; the parameter count
278 // is justified by the MCP wire shape which needs distinct named fields
279 // for pkg / code_file / code (mutually exclusive) plus filtering options.
280 #[allow(clippy::too_many_arguments)]
281 async fn pkg_test(
282 &self,
283 pkg: Option<String>,
284 code_file: Option<String>,
285 code: Option<String>,
286 spec_dir: Option<String>,
287 filter: Option<String>,
288 search_paths: Option<Vec<String>>,
289 project_root: Option<String>,
290 ) -> Result<String, String>;
291
292 // ─── Logging ─────────────────────────────────────────────
293
294 /// Append a note to a session's log file.
295 async fn add_note(
296 &self,
297 session_id: &str,
298 content: &str,
299 title: Option<&str>,
300 ) -> Result<String, String>;
301
302 /// View session logs.
303 async fn log_view(
304 &self,
305 session_id: Option<&str>,
306 limit: Option<usize>,
307 max_chars: Option<usize>,
308 ) -> Result<String, String>;
309
310 /// Aggregate stats across all logged sessions.
311 async fn stats(
312 &self,
313 strategy_filter: Option<&str>,
314 days: Option<u64>,
315 ) -> Result<String, String>;
316
317 // ─── Project lifecycle ────────────────────────────────────
318
319 /// Initialize `alc.toml` in the given project root.
320 ///
321 /// Creates a minimal `alc.toml` (`[packages]` section only).
322 /// Fails if `alc.toml` already exists (no overwrite).
323 async fn init(&self, project_root: Option<String>) -> Result<String, String>;
324
325 /// Re-resolve all `alc.toml` entries and rewrite `alc.lock`.
326 ///
327 /// Requires an `alc.toml` to be present. Returns resolved count and errors.
328 async fn update(&self, project_root: Option<String>) -> Result<String, String>;
329
330 /// Migrate a legacy `alc.lock` to `alc.toml` + new `alc.lock` format.
331 ///
332 /// Detects legacy format via `linked_at` / `local_dir` fields.
333 /// Backs up the old lock file as `alc.lock.bak`.
334 async fn migrate(&self, project_root: Option<String>) -> Result<String, String>;
335
336 // ─── Package narrative (issue #1778221491-39903) ─────────
337
338 /// Render the narrative markdown for a package on-the-fly.
339 ///
340 /// Extracts the init.lua docstring H2/H3 sections via the embedded
341 /// gendoc pipeline (`extract.split_sections` + `projections.narrative_md`)
342 /// and returns the rendered markdown string.
343 ///
344 /// Returns `Ok(Some(markdown))` when the pkg is found and its init.lua
345 /// is loadable. Returns `Ok(None)` when the pkg is not installed.
346 /// Returns `Err(...)` when the pkg is found but the gendoc pipeline fails
347 /// (e.g. malformed init.lua).
348 async fn pkg_get_narrative_md(&self, name: &str) -> Result<Option<String>, String>;
349
350 // ─── Session activation (issue #1776627475) ──────────────
351
352 /// Activate a session pin for the current MCP connection.
353 ///
354 /// `project_root` is resolved at activation time using the
355 /// existing fallback chain (P > E > W) and cached on the
356 /// `AppService`. Subsequent tool calls without an explicit
357 /// `project_root` argument resolve via P > **S** > E > W,
358 /// where S is this pin (issue #1776627475 §6).
359 ///
360 /// `mode` accepts `"default"` (or `None`) and `"test"`. Unknown
361 /// values return a typed error rather than silent fallback.
362 /// Mode is exposed back to callers so downstream tools can
363 /// adapt behaviour (e.g. scenario test isolation).
364 ///
365 /// Returns a JSON string with `session_id`, `project_root`
366 /// (resolved or `null`), and `mode`.
367 async fn session_new(
368 &self,
369 project_root: Option<String>,
370 mode: Option<String>,
371 ) -> Result<String, String>;
372
373 // ─── Cards ───────────────────────────────────────────────
374
375 /// List Card summaries, optionally filtered by pkg.
376 async fn card_list(&self, pkg: Option<String>) -> Result<String, String>;
377
378 /// Fetch a full Card by id.
379 async fn card_get(&self, card_id: &str) -> Result<String, String>;
380
381 /// Filter/sort Cards using the Prisma-style `where` DSL.
382 ///
383 /// - `pkg`: restricts filesystem scan to a single pkg subdir (I/O hint).
384 /// - `where_`: nested-object predicate (see `card::parse_where`).
385 /// - `order_by`: array of dotted-path sort keys; `-` prefix = desc.
386 /// - `limit` / `offset`: pagination.
387 async fn card_find(
388 &self,
389 pkg: Option<String>,
390 where_: Option<serde_json::Value>,
391 order_by: Option<serde_json::Value>,
392 limit: Option<usize>,
393 offset: Option<usize>,
394 ) -> Result<String, String>;
395
396 /// List aliases, optionally filtered by pkg.
397 async fn card_alias_list(&self, pkg: Option<String>) -> Result<String, String>;
398
399 /// Resolve an alias name to its bound Card and return the full Card JSON.
400 async fn card_get_by_alias(&self, name: &str) -> Result<String, String>;
401
402 /// Bind (or rebind) an alias to a Card.
403 async fn card_alias_set(
404 &self,
405 name: &str,
406 card_id: &str,
407 pkg: Option<String>,
408 note: Option<String>,
409 ) -> Result<String, String>;
410
411 /// Append new top-level fields to an existing Card (additive-only).
412 async fn card_append(&self, card_id: &str, fields: serde_json::Value)
413 -> Result<String, String>;
414
415 /// Install Cards from a Card Collection repo (Git URL or local path).
416 async fn card_install(&self, url: String) -> Result<String, String>;
417
418 /// Read per-case samples from a Card's sidecar JSONL file.
419 ///
420 /// `where_` applies the same Prisma-style DSL used by `card_find`
421 /// to each sample row; offset/limit page the post-filter stream.
422 async fn card_samples(
423 &self,
424 card_id: &str,
425 offset: Option<usize>,
426 limit: Option<usize>,
427 where_: Option<serde_json::Value>,
428 ) -> Result<String, String>;
429
430 /// Walk a Card's lineage tree via `metadata.prior_card_id`.
431 ///
432 /// - `direction`: `"up"` | `"down"` | `"both"` (default `"up"`).
433 /// - `depth`: max traversal depth (default 10).
434 /// - `include_stats`: include each node's `[stats]` section.
435 /// - `relation_filter`: optional list of accepted `prior_relation` values.
436 async fn card_lineage(
437 &self,
438 card_id: &str,
439 direction: Option<String>,
440 depth: Option<usize>,
441 include_stats: Option<bool>,
442 relation_filter: Option<Vec<String>>,
443 ) -> Result<String, String>;
444
445 /// Backfill one subscriber (`sink` URI) with all cards from the
446 /// primary store. Drift-safe: cards already present on the sink are
447 /// skipped (never overwritten). Returns a `SinkBackfillReport`
448 /// serialized as a JSON string.
449 async fn card_sink_backfill(&self, _sink: String, _dry_run: bool) -> Result<String, String> {
450 Err("card_sink_backfill: not implemented by this EngineApi impl".into())
451 }
452
453 /// Run a Card analyzer package over a single Card.
454 ///
455 /// The host loads the Card body + samples sidecar, builds a Lua ctx
456 /// (`{ card, samples, card_id }`), and dispatches to the named pkg
457 /// via `require(pkg).run(ctx)`. The default pkg name is
458 /// `"card_analysis"` — backed by the constant
459 /// `DEFAULT_CARD_ANALYZE_PKG` defined in `algocline_app::service::card`.
460 /// This is an IF promise, not a bundled hard dependency.
461 /// If the pkg is missing the call returns an error.
462 ///
463 /// Sister tool to `advice`: `advice` runs a generic strategy over
464 /// a free-form task, while `card_analyze` runs an analyzer over a
465 /// Card and its samples. The Card domain is owned by the host
466 /// (Card schema parsing + samples sidecar load), not the pkg.
467 async fn card_analyze(&self, _card_id: &str, _pkg: Option<String>) -> Result<String, String> {
468 Err("card_analyze: not implemented by this EngineApi impl".into())
469 }
470
471 // ─── Hub ─────────────────────────────────────────────────
472
473 /// Rebuild hub index from a packages directory.
474 ///
475 /// When `source_dir` is provided, scans that directory directly
476 /// (pure metadata, no manifest). When omitted, scans `~/.algocline/packages/`.
477 async fn hub_reindex(
478 &self,
479 output_path: Option<String>,
480 source_dir: Option<String>,
481 ) -> Result<String, String>;
482
483 /// Generate human-readable documentation artifacts from a hub index.
484 ///
485 /// Runs the embedded Lua `gen_docs` pipeline (originally shipped
486 /// with `algocline-bundled-packages`) against `source_dir`, which
487 /// must contain a fresh `hub_index.json`. Emits
488 /// `narrative/{pkg}.md`, `llms.txt`, `llms-full.txt` under
489 /// `out_dir` (defaults to `{source_dir}/docs`), plus optional
490 /// projections depending on `projections`:
491 ///
492 /// - `"hub"` → `{out_dir}/hub/{pkg}.json`
493 /// - `"context7"` → `{source_dir}/context7.json`
494 /// - `"devin"` → `{source_dir}/.devin/wiki.json`
495 /// - `"lint"` → run V0 lint pass (warnings only)
496 /// - `"lint_only"` → run lint, skip file generation
497 ///
498 /// `config_path` — optional path to a TOML config file. When omitted,
499 /// the project root's `alc.toml` is auto-explored for `[hub.context7]`
500 /// and `[hub.devin]` sections. Core defaults apply when neither a
501 /// `config_path` nor `alc.toml` provides projection config. Passing a
502 /// `.lua` path is a typed error (retired). See
503 /// `docs/hub-gendoc-config.md` for the full schema.
504 ///
505 /// Projection names are validated strictly and unknown values are
506 /// rejected with `Err("gendoc: unknown projection ...")`.
507 ///
508 /// `lint_strict = true` upgrades lint errors to a hard failure
509 /// (equivalent to the `--strict` CLI flag).
510 ///
511 /// Returns a JSON string containing the collected stdout / stderr
512 /// plus the resolved `source_dir` / `out_dir` for observability.
513 async fn hub_gendoc(
514 &self,
515 source_dir: String,
516 out_dir: Option<String>,
517 projections: Option<Vec<String>>,
518 config_path: Option<String>,
519 lint_strict: Option<bool>,
520 ) -> Result<String, String>;
521
522 /// Run `hub_reindex` followed by `hub_gendoc` as a single facade.
523 ///
524 /// This is a convenience wrapper for downstream hub repositories that
525 /// want to regenerate the index and the public docs in one call. The
526 /// composed response is a JSON object:
527 ///
528 /// ```json
529 /// {
530 /// "reindex": <hub_reindex response>,
531 /// "gendoc": <hub_gendoc response>,
532 /// "preset_catalog_version": "...",
533 /// "preset": { "name": ..., "catalog_version": ..., "resolved": { ... } }
534 /// }
535 /// ```
536 ///
537 /// Error propagation:
538 ///
539 /// - If `hub_reindex` fails, `hub_dist` returns immediately with
540 /// `Err("dist: reindex failed: {inner}")` and does not invoke
541 /// `hub_gendoc`.
542 /// - If `hub_gendoc` fails, the error text includes the reindex JSON
543 /// that already succeeded:
544 /// `Err("dist: gendoc failed: {inner}\nreindex result (succeeded): {json}")`.
545 /// The reindex-side side effects (written `hub_index.json`) are not
546 /// rolled back.
547 ///
548 /// `output_path` is the `hub_index.json` destination (reindex arg).
549 /// Callers typically pass `{source_dir}/hub_index.json` so the
550 /// subsequent gendoc step can read it back.
551 ///
552 /// Presets (`preset`) are expanded inside `hub_dist` into primitive
553 /// `hub_gendoc` arguments (`projections` / `config_path` /
554 /// `lint_strict`). When `preset` is set, the successful JSON response
555 /// includes a `preset` object with `catalog_version` plus the fully
556 /// resolved knobs for observability.
557 ///
558 /// Merge order (strongest wins):
559 /// 1) explicit MCP arguments (`projections` / `config_path` / `lint_strict`)
560 /// 2) optional `alc.toml` overrides under `[hub.dist.presets.<name>]`
561 /// (keyed by `project_root`) — only fills **omitted** knobs
562 /// 3) builtin `Current` defaults for the selected preset
563 #[allow(clippy::too_many_arguments)]
564 async fn hub_dist(
565 &self,
566 source_dir: String,
567 output_path: Option<String>,
568 out_dir: Option<String>,
569 preset: Option<String>,
570 project_root: Option<String>,
571 projections: Option<Vec<String>>,
572 config_path: Option<String>,
573 lint_strict: Option<bool>,
574 ) -> Result<String, String>;
575
576 /// Show detailed information for a single package.
577 async fn hub_info(&self, pkg: String) -> Result<String, String>;
578
579 /// Search packages across remote index + local install state.
580 ///
581 /// This trait method mirrors the MCP `alc_hub_search` tool. Parameters
582 /// are deliberately individual JSON-primitive `Option<T>` values
583 /// (rather than an aggregate struct) so that the `algocline-core` crate
584 /// stays free of `algocline-app`-internal types (see plan.md §4.1).
585 /// The `algocline-app` side of the impl folds these into its
586 /// `pub(crate) ListOpts` struct.
587 ///
588 /// - `limit` is `Option<i32>` at this layer (MCP/JSON boundary). The
589 /// impl casts to `usize` internally.
590 /// - `filter` is a free-form JSON object; it is `Deserialize`d into
591 /// a `HashMap<String, Value>` inside the app layer.
592 /// - `fields` / `verbose` drive projection; `fields` wins when both
593 /// are supplied.
594 #[allow(clippy::too_many_arguments)]
595 async fn hub_search(
596 &self,
597 query: Option<String>,
598 category: Option<String>,
599 installed_only: Option<bool>,
600 limit: Option<i32>,
601 sort: Option<String>,
602 filter: Option<serde_json::Value>,
603 fields: Option<Vec<String>>,
604 verbose: Option<String>,
605 local_indices: Option<Vec<String>>,
606 ) -> Result<String, String>;
607
608 // ─── Package scaffold ─────────────────────────────────────
609
610 /// Generate a minimal package skeleton at `<target_dir>/<name>/init.lua`.
611 ///
612 /// Writes an `M.meta` / `M.spec.entries.run` / `M.run` template with a
613 /// pre-filled `alc_shapes_compat` range derived from the embedded
614 /// alc_shapes version. Optional `category` / `description` are emitted
615 /// as uncommented fields in `M.meta` when provided.
616 ///
617 /// Returns `{ "status": "ok", "path": "...", "bytes_written": N }` on
618 /// success. Typed errors (`NameInvalid`, `AlreadyExists`, `IoError`) are
619 /// propagated via `Err(String)` to the MCP wire response.
620 async fn pkg_scaffold(
621 &self,
622 name: String,
623 target_dir: Option<String>,
624 category: Option<String>,
625 description: Option<String>,
626 ) -> Result<String, String>;
627
628 /// Read the `init.lua` source of an installed package.
629 ///
630 /// Searches global (`~/.algocline/packages/`) and variant
631 /// (`alc.local.toml`) scope in priority order (variant wins).
632 /// Returns the raw Lua source on success, or an `Err(String)` describing
633 /// why the package was not found or could not be read.
634 async fn pkg_read_init_lua(&self, name: &str) -> Result<String, String>;
635
636 /// Read metadata for a single installed package.
637 ///
638 /// Returns the JSON object string for one package entry (the same shape
639 /// `pkg_list` returns inside `packages[*]`). `Err("pkg not found: ...")`
640 /// when the package is unknown.
641 async fn pkg_meta(&self, name: &str) -> Result<String, String>;
642
643 // ─── Diagnostics ─────────────────────────────────────────
644
645 /// Show server configuration and diagnostic info.
646 async fn info(&self) -> String;
647
648 // ─── Hub resources ───────────────────────────────────────
649
650 /// Return the aggregated hub index across all registered sources as a JSON string.
651 ///
652 /// Merges the cached `hub_index.json` from every discovered source URL.
653 /// Sources that fail to load produce warnings that are embedded in the
654 /// returned JSON under a `"warnings"` field so the MCP caller can observe
655 /// partial failures.
656 ///
657 /// Returns `Ok(json_string)` where the JSON has shape:
658 /// ```json
659 /// { "schema_version": "hub_index/v0", "packages": [...], "warnings": [...] }
660 /// ```
661 /// Returns `Err(message)` only when the hub registries file itself is
662 /// corrupt (hard I/O failure), making further index discovery impossible.
663 async fn hub_index_aggregate(&self) -> Result<String, String>;
664
665 // ─── Pool management ─────────────────────────────────────────
666
667 /// Ensure pool workers are alive; GC stale entries. Idempotent.
668 ///
669 /// Returns JSON `{"sessions": [...], "pool_version": "..."}`.
670 async fn pool_ensure(&self) -> Result<String, String>;
671
672 /// Return pool worker status (registry.json + live state).
673 ///
674 /// When `sid` is provided, restricts to a single worker.
675 /// Returns JSON `{"sessions": [...], "pool_version": "..."}`.
676 async fn pool_status(&self, sid: Option<String>) -> Result<String, String>;
677
678 /// Send SIGTERM to all workers (`sid=None`) or a single worker.
679 ///
680 /// Returns JSON `{"stopped": [...], "errors": [...]}`.
681 async fn pool_stop(&self, sid: Option<String>) -> Result<String, String>;
682}