UpdateSpecArgs

Struct UpdateSpecArgs 

Source
pub struct UpdateSpecArgs {
    pub project_name: String,
    pub spec_name: String,
    pub spec: Option<String>,
    pub tasks: Option<String>,
    pub notes: Option<String>,
    pub operation: String,
    pub context_patch: Option<String>,
}
Expand description

Arguments for update_spec command

Fields§

§project_name: String

Project name containing the spec to update

Must be an existing project in ~/.foundry/ Use ‘foundry list-projects’ to see available projects

§spec_name: String

Spec name to update (YYYYMMDD_HHMMSS_feature_name format)

Must be an existing spec within the project Use ‘foundry load-project PROJECT_NAME’ to see available specs

§spec: Option<String>

New content for spec.md (optional)

Complete Content Replacement (–operation replace):

  • Entirely replaces the existing spec.md content
  • Use for major requirement changes or complete rewrites
  • Existing content is lost - ensure you have backups if needed

Content Addition (–operation append):

  • Adds new content to the end of existing spec.md
  • Preserves existing requirements and specifications
  • Use for iterative spec development and additions

Markdown Formatting Guidelines:

  • Use # Feature Name as main header
  • Use ## for major sections (## Overview, ## Requirements, ## Implementation)
  • Include functional requirements, acceptance criteria, technical approach
  • Use bullet points, numbered lists, and code blocks as needed
§tasks: Option<String>

New content for task-list.md (optional)

Complete Content Replacement (–operation replace):

  • Entirely replaces the existing task-list.md content
  • Use when completely restructuring the implementation plan
  • Existing task history is lost

Content Addition (–operation append):

  • Adds new tasks to the end of existing task-list.md
  • Preserves existing task history and completion status
  • Use for adding new tasks or marking existing tasks as complete

Markdown Checklist Format:

  • Use “## Phase Name” headers to group related tasks
  • Use “- [ ] Task description” for uncompleted tasks
  • Use “- [x] Task description” for completed tasks
  • Include implementation details and dependencies
§notes: Option<String>

New content for notes.md (optional)

Complete Content Replacement (–operation replace):

  • Entirely replaces the existing notes.md content
  • Use when consolidating or restructuring design decisions
  • Existing notes and rationale are lost

Content Addition (–operation append):

  • Adds new notes to the end of existing notes.md
  • Preserves existing design decisions and implementation notes
  • Use for adding new insights, decisions, or implementation details

Markdown Formatting Guidelines:

  • Use ## headers for different categories (## Design Decisions, ## Implementation Notes)
  • Document technical tradeoffs, constraints, and rationale
  • Include code snippets, external references, and future considerations
  • Keep notes conversational but technical
§operation: String

Content replacement strategy (REQUIRED)

replace: Completely replaces the target file content with new content

  • Use when: Completely rewriting content, major changes, starting fresh
  • Risk: Existing content is lost permanently
  • Example: Major requirement changes, technical direction changes

append: Adds new content to the end of existing file content

  • Use when: Adding new content, iterative development, preserving history
  • Risk: Low - existing content is preserved
  • Example: Adding new tasks, accumulating notes, marking items complete

Applies to ALL files being updated in this command.

§context_patch: Option<String>

Context-based patch data (JSON string, optional)

Context-Based Patching (–operation context_patch):

  • Enables precise, targeted updates using surrounding text context
  • Avoids need for line number precision or full file replacement
  • Use JSON format with before_context, after_context, and content fields
  • Supports fuzzy matching for minor formatting variations
  • Example: {“file_type”:“spec”,“operation”:“insert”,“before_context”:[“- User auth”],“after_context”:[“- Session mgmt”],“content”:“- Two-factor auth”}

When to use context_patch:

  • Small targeted changes (mark task complete, add single requirement)
  • Precise insertions between existing content
  • Updates where you know the surrounding context

JSON Schema Requirements:

  • file_type: “spec”, “tasks”, or “notes”
  • operation: “insert”, “replace”, or “delete”
  • before_context: Array of strings (3-5 lines recommended)
  • after_context: Array of strings (3-5 lines recommended)
  • content: String content to insert/replace
  • section_context: Optional header for disambiguation (e.g., “## Requirements”)
  • match_config: Optional matching configuration

Trait Implementations§

Source§

impl Args for UpdateSpecArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for UpdateSpecArgs

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for UpdateSpecArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl McpToolDefinition for UpdateSpecArgs

Source§

fn tool_definition() -> Tool

Generate the MCP tool definition from the struct
Source§

fn from_mcp_params(params: &Value) -> Result<Self>

Convert MCP parameters to the CLI argument struct

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,