nbspec 0.2.0

Notebook-first OpenSpec orchestration for spec-driven development
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

//! Tool argument structs for the MCP server.
//!
//! Each struct derives `Deserialize` (so rmcp can deserialize MCP tool
//! arguments), `JsonSchema` (so rmcp can publish the JSON schema to
//! clients), and `Default` (so an empty arg object is treated as
//! "no overrides"). `#[serde(deny_unknown_fields)]` mirrors the
//! strictness policy of the existing CLI: silent acceptance of
//! unknown keys is rejected, so a misspelled parameter surfaces as
//! a schema-validation error rather than a confusing runtime
//! misbehavior.
//!
//! Per-tool notebook overrides are intentionally absent: the
//! specification pins notebook resolution to the server lifetime
//! (startup `--notebook` wins; otherwise git-derived), so exposing a
//! `notebook` parameter on each tool would invite callers to override
//! a value that the server has committed to ignore.

use schemars::JsonSchema;
use serde::Deserialize;

use crate::reviews::VerdictValue;

#[derive(Debug, Default, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct CreateArgs {
    /// Change identifier (becomes the folder name under `proposals/`).
    pub change_id: String,

    /// Human-readable change title.
    #[serde(default)]
    #[schemars(with = "String")]
    pub title: Option<String>,
}

#[derive(Debug, Default, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct DisplayArgs {
    /// Change identifier (notebook folder under `proposals/`).
    pub change_id: String,

    /// Includes artifact note contents and folder listings.
    #[serde(default)]
    pub full: bool,
}

#[derive(Debug, Default, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct ValidateArgs {
    /// Change identifier (notebook folder under `proposals/`).
    pub change_id: String,
}

#[derive(Debug, Default, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct RenderArgs {
    /// Change identifier (notebook folder under `proposals/`).
    pub change_id: String,

    /// Emits a unified diff against current merge targets rather than
    /// the rendered file tree. Matches `nbspec render --diff`; pipes
    /// cleanly into review tooling such as difit.
    #[serde(default)]
    pub diff: bool,
}

fn merge_gate() -> String {
    crate::reviews::MERGE_GATE.to_string()
}

#[derive(Debug, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct ReviewArgs {
    /// Change identifier (notebook folder under `proposals/`).
    pub change_id: String,

    /// Review gate the verdict addresses; defaults to `merge`, the
    /// only slice-1 gate.
    #[serde(default = "merge_gate")]
    pub gate: String,

    /// Verdict value: `approve` or `revise`.
    pub verdict: VerdictValue,

    /// Comment, e.g. a findings note selector. REQUIRED for a revise
    /// verdict; optional for approve. Recorded verbatim.
    #[serde(default)]
    #[schemars(with = "String")]
    pub comment: Option<String>,

    /// Reviewer identity; defaults to Git user.name. An explicit
    /// empty value is refused, never treated as absence.
    #[serde(default)]
    #[schemars(with = "String")]
    pub reviewer: Option<String>,
}

#[derive(Debug, Default, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct MergeArgs {
    /// Change identifier (notebook folder under `proposals/`).
    pub change_id: String,

    /// Overwrites merge targets that drifted since the last merge.
    /// Does NOT override unsupported-delta refusals (MODIFIED /
    /// REMOVED / RENAMED) or non-file occupants; those remain
    /// unimplemented and require explicit operator intervention.
    #[serde(default)]
    pub force: bool,
}