mcp

type Backend interface {
	// Name is what the workbook is called, for titles: its file's name.
	Name() string
	// View runs fn on the workbook as it is, which fn must not change.
	View(ctx context.Context, fn func(*sheet.Workbook) error) error
	// Scratch runs fn on a copy of the workbook that is thrown away.
	Scratch(ctx context.Context, fn func(*sheet.Workbook) error) error
	// Change runs fn on the workbook inside one Batch, labelled label,
	// and returns what it changed. The change is kept unless fn fails or
	// dryRun is set; a failed change leaves the workbook as it was.
	Change(ctx context.Context, label string, dryRun bool, fn func(*sheet.Workbook) error) ([]diff.Change, error)
}

type Changed struct {
	Saved    bool              `json:"saved"`
	Changes  []headless.Change `json:"changes"`
	Warnings []string          `json:"warnings"`
	// Suggestion and Notices are live mode's: the change waiting for
	// the person, and what became of earlier ones.
	Suggestion int      `json:"suggestion,omitempty" jsonschema:"live mode: the suggestion's number, waiting for the person to accept or reject it"`
	Notices    []string `json:"notices,omitempty" jsonschema:"live mode: what became of your earlier suggestions"`
}

type FileBackend struct {
	Path string
	// Prepare, when set, runs on the workbook once opened, before fn:
	// what the server's flags allow (answering JEV functions).
	Prepare func(context.Context, *headless.File) error
	// Save writes a changed workbook; nil is File.Save.
	Save func(*headless.File) error
	// contains filtered or unexported fields
}

type ImportBackend struct {
	Path    string
	Prepare func(context.Context, *headless.File) error
}

type Live interface {
	Backend
	// Make makes a change as the agent's, or suggests it.
	Make(ctx context.Context, m Making) (Made, error)
	// Focus moves the agent's pointer to ref, for the person to see
	// where it's looking, and says where that is.
	Focus(ctx context.Context, ref string) (string, error)
	// Undo takes back the agent's latest step, saying what it was.
	Undo(ctx context.Context) (string, error)
	// Ask asks the person a question, as an elicitation request asks a
	// host's user, and returns their answer.
	Ask(ctx context.Context, p *sdk.ElicitParams) (*sdk.ElicitResult, error)
	// Suggestions are the agent's suggestions and what became of them.
	Suggestions(ctx context.Context) ([]Suggestion, error)
	// RunCell has the person's session run a notebook cell, once they
	// allow it, and says what happens next.
	RunCell(ctx context.Context, notebook string, cell int) (string, error)
	// Scope is what the person let the agent change, in words.
	Scope() string
}

type Made struct {
	Changes    []diff.Change
	Applied    bool
	Suggestion int
	Notices    []string
}

type Making struct {
	Label, Message string
	DryRun         bool
	Fn             func(*sheet.Workbook) error
}

type Options struct {
	// Version is 012's, which the server reports.
	Version string
	// ReadOnly leaves out every tool that changes a workbook.
	ReadOnly bool
	// Force lets writes change protected ranges, as 012 set --force.
	Force bool
	// Notebooks, when set, lets run_notebook_cell run cells with nu, as
	// --notebooks does; nil leaves the tool out. MayRun says why a
	// workbook's cells may not run here (trust, the shell setting), and
	// may mark it trusted, as the command line's --trust does.
	Notebooks *headless.NotebookOptions
	MayRun    func(path string, w *sheet.Workbook) error
	// Roots are the folders workbooks may be in when the client shares
	// none of its own (NewRoots makes them).
	Roots []confine.Root
	// Default, an absolute path, is the workbook of tools called without
	// a path, open wherever it is; "" makes the path required.
	Default string
	// Prepare, when set, runs on every workbook once opened (answering
	// JEV functions); Save writes a changed one, nil being File.Save.
	Prepare func(context.Context, *headless.File) error
	Save    func(*headless.File) error
	// Live, when set, is the one workbook of a server attached to a
	// session (live mode, live.go): every tool works on it, and the
	// live tools are added. Roots, Default and Notebooks go unused.
	Live Live
}

type RangeRead = headless.Range

type Server struct {
	*sdk.Server
	// contains filtered or unexported fields
}

type Suggestion struct {
	ID       int    `json:"id"`
	Label    string `json:"label"`
	Message  string `json:"message,omitempty"`
	State    string `json:"state" jsonschema:"pending, accepted, accepted in part or rejected"`
	Cells    int    `json:"cells" jsonschema:"the cells it sets"`
	Accepted int    `json:"accepted" jsonschema:"the cells the person accepted"`
	Rejected int    `json:"rejected" jsonschema:"the cells the person rejected"`
}

type View struct {
	Title string `json:"title"`
	Name  string `json:"name,omitempty"`
	Where string `json:"where"`
	HTML  string `json:"html"`
}