mcp

type ComposeIn = types.ComposedRequest

type ComposeOut = types.ComposedResponse

type Config struct {
	Version string

	// DefaultReturn is the `return` preset an MCP request without its
	// own block is shaped by (return_default.go). Empty defers to the
	// instance default (pulse.Options.DefaultReturn, else the feature
	// profile's `return`), else the built-in `standard`. `full` restores
	// the library's unshaped output.
	DefaultReturn types.ReturnPreset
}

type DedupIn struct {
	Path          string          `` /* 168-byte string literal not displayed */
	Groups        []pio.GroupDecl `` /* 546-byte string literal not displayed */
	SuggestGroups bool            `` /* 407-byte string literal not displayed */
	Out           string          `` /* 287-byte string literal not displayed */
}

type DedupOut = pulse.DedupResult

type DropIn struct {
	Handle string `json:"handle" jsonschema:"Managed handle name to remove"`
}

type DropOut struct {
	Handle  string `json:"handle" jsonschema:"The managed handle that was dropped"`
	Dropped bool   `json:"dropped" jsonschema:"True when the handle existed and was removed"`
}

type ErrorsLookupIn struct {
	Code   string `json:"code,omitempty" jsonschema:"Exact error code identifier (e.g. 'PULSE_LOOKUP_MISS')"`
	Domain string `json:"domain,omitempty" jsonschema:"Domain prefix (PULSE, ENCODING, PROCESSING, SERVICE, DATA, CLI); case-insensitive"`
	Query  string `json:"query,omitempty" jsonschema:"Case-insensitive substring across descriptions and fixup hints"`
}

type ErrorsLookupOut struct {
	Results []perr.LookupResult `json:"results" jsonschema:"Matching error-code metadata records"`
}

type ExamplesGetIn struct {
	Name string `json:"name" jsonschema:"Example name from the _meta.name field (e.g. 't_test_one_sample')"`
}

type ExamplesGetOut = examples.Example

type ExamplesSearchIn struct {
	Query    string   `` /* 342-byte string literal not displayed */
	Tags     []string `json:"tags,omitempty" jsonschema:"Canonical taxonomy tags; results must carry every tag (AND)"`
	Category string   `` /* 185-byte string literal not displayed */
	Intent   string   `` /* 157-byte string literal not displayed */
}

type ExamplesSearchOut struct {
	Results []examples.ExampleSummary `json:"results" jsonschema:"Matching example summaries (name, category, tags, operators, description)"`
}

type ExplainIn struct {
	Request          map[string]any `` /* 188-byte string literal not displayed */
	Composed         map[string]any `` /* 152-byte string literal not displayed */
	Chain            map[string]any `` /* 152-byte string literal not displayed */
	Facet            map[string]any `` /* 142-byte string literal not displayed */
	Sample           map[string]any `json:"sample,omitempty" jsonschema:"A pulse_sample request, described before it runs (never predicted)."`
	Response         map[string]any `` /* 135-byte string literal not displayed */
	ComposedResponse map[string]any `json:"composed_response,omitempty" jsonschema:"A pulse_compose result ({responses, overlays}) to read slot by slot."`
	ChainResponse    map[string]any `` /* 143-byte string literal not displayed */
	FacetResult      map[string]any `json:"facet_result,omitempty" jsonschema:"A pulse_facet result to read field by field."`
	Detail           string         `` /* 166-byte string literal not displayed */
}

type ExplainOut = descriptor.ExplainResult

type FacetIn struct {
	Path  string `json:"path" jsonschema:"Filesystem path to the .pulse file"`
	Field string `json:"field" jsonschema:"Field name to facet"`
}

type FacetOut struct {
	Values []string `json:"values" jsonschema:"Distinct values for the faceted field"`
}

type FacetSchemaIn = types.FacetRequest

type FacetSchemaOut = types.FacetResult

type ImportIn struct {
	Source    string `json:"source" jsonschema:"Filesystem path to the source file (relative to PULSE_DATA_DIR)"`
	Format    string `json:"format,omitempty" jsonschema:"Format override: csv, tsv, ndjson, jsonarray, parquet, arrow, excel, spss, pulse"`
	Handle    string `json:"handle,omitempty" jsonschema:"Managed handle name; defaults to source basename without extension"`
	TTL       string `` /* 127-byte string literal not displayed */
	Sheet     string `json:"sheet,omitempty" jsonschema:"Excel sheet name; ignored for non-Excel sources"`
	Charset   string `` /* 604-byte string literal not displayed */
	Overwrite bool   `json:"overwrite,omitempty" jsonschema:"Replace an existing handle of the same name. Default false."`
	// SourceTZ / ColumnSourceTZ / SourceTZField / DSTPolicy are io.ImportJob's
	// source-zone options, persisted onto the managed sidecar.
	SourceTZ       string            `` /* 433-byte string literal not displayed */
	ColumnSourceTZ map[string]string `` /* 233-byte string literal not displayed */
	SourceTZField  string            `` /* 584-byte string literal not displayed */
	DSTPolicy      string            `` /* 436-byte string literal not displayed */
	// Groups and SuggestGroups carry the parent-group surface. See the
	// slot-policy note below for why there is no ratio-floor or strict
	// slot beside them.
	Groups        []pio.GroupDecl `` /* 983-byte string literal not displayed */
	SuggestGroups bool            `` /* 544-byte string literal not displayed */
	// Vectors / VectorKinds are io.ImportJob.Vectors in the CLI's own
	// --vector / --vector-kind syntax, parsed by the same
	// io.ParseVectorDecl / io.ApplyVectorKinds.
	Vectors     []string `` /* 1291-byte string literal not displayed */
	VectorKinds []string `` /* 331-byte string literal not displayed */
	// Schema / IgnoreExtra / Float are io.ImportJob's explicit-schema and
	// float-width options, the CLI's --schema / --ignore-extra / --float.
	// None is persisted on the sidecar (see imports.Spec.Schema).
	Schema      []ImportSchemaField `` /* 897-byte string literal not displayed */
	IgnoreExtra bool                `` /* 314-byte string literal not displayed */
	Float       string              `` /* 288-byte string literal not displayed */
}

type ImportOut = imports.Result

type ImportSchemaField struct {
	Name        string `` /* 143-byte string literal not displayed */
	Type        string `` /* 306-byte string literal not displayed */
	Nullable    bool   `` /* 151-byte string literal not displayed */
	Description string `json:"description,omitempty" jsonschema:"Field description stored in the cohort header (max 1000 bytes)."`
	Precision   uint8  `json:"precision,omitempty" jsonschema:"decimal128 only: total significant digits."`
	Scale       uint8  `json:"scale,omitempty" jsonschema:"decimal128 only: digits after the decimal point."`
	// Dim / Labels / Kind / ScaleMin / ScaleMax are the vector keys of
	// io.SchemaFileField (vec_f32 / vec_f64 only).
	Dim      int      `` /* 214-byte string literal not displayed */
	Labels   []string `` /* 190-byte string literal not displayed */
	Kind     string   `json:"kind,omitempty" jsonschema:"vec_f32 / vec_f64 only: measure, scale, composition or binary."`
	ScaleMin *float64 `json:"scale_min,omitempty" jsonschema:"vec_f32 / vec_f64 only: declared value-range lower bound; needs scale_max."`
	ScaleMax *float64 `json:"scale_max,omitempty" jsonschema:"vec_f32 / vec_f64 only: declared value-range upper bound; needs scale_min."`
}

type ImportsListIn struct{}

type ImportsListOut struct {
	Imports []imports.Entry `json:"imports" jsonschema:"Managed-import pool entries with sidecar metadata"`
}

type InspectIn struct {
	Path string `json:"path" jsonschema:"Filesystem path to the .pulse file"`
	// Joins names the cohorts the session's requests will join. It
	// changes no inspect output: on a server binding tools on inspect,
	// the request-carrying tools widen their field enums with each
	// target's joined names (mcp.BindForInstanceWithJoins).
	Joins []InspectJoin `` /* 281-byte string literal not displayed */
}

type InspectJoin struct {
	Right string `json:"right" jsonschema:"Right-side cohort path, as in a request's joins[].right"`
	As    string `json:"as,omitempty" jsonschema:"The as prefix the request's join will carry (empty: none)"`
}

type InspectOut struct {
	descriptor.InspectResult
	Warnings []*descriptor.EnvelopeEntry `` /* 227-byte string literal not displayed */
}

type InvokeFunc func(ctx context.Context, p *pulse.Pulse, raw json.RawMessage) (any, error)

type JoinTarget struct {
	Schema *encoding.Schema
	As     string
}

type LabelResolveIn struct {
	Table string `json:"table" jsonschema:"Label table name (from pulse_label_tables, e.g. 'brand')"`
	Query string `json:"query,omitempty" jsonschema:"Name to resolve, case-insensitive; empty returns the first rows (browse mode)"`
	Limit int    `json:"limit,omitempty" jsonschema:"Maximum matches to return. Default 10."`
}

type LabelResolveOut struct {
	Matches []pulse.LabelMatch `json:"matches" jsonschema:"Ranked (key, value, score) resolution candidates"`
}

type LabelTablesIn struct{}

type LabelTablesOut struct {
	Tables []pulse.LabelTableInfo `json:"tables" jsonschema:"Registered label tables (name, row count, enumerable flag)"`
}

type LookupIn = types.LookupRequest

type LookupOut = types.LookupResult

type ManifestIn struct {
	Intent string `` /* 284-byte string literal not displayed */
}

type ManifestOut = descriptor.Manifest

type MaterializeIn struct {
	Request   *types.Request `` /* 383-byte string literal not displayed */
	Out       string         `` /* 217-byte string literal not displayed */
	Overwrite bool           `` /* 240-byte string literal not displayed */
}

type MaterializeOut = pulse.MaterializeResult

type PredictIn struct {
	types.Request
	Composed *types.ComposedRequest `` /* 175-byte string literal not displayed */
	Facet    *types.FacetRequest    `json:"facet,omitempty" jsonschema:"A pulse_facet_schema request to predict instead of a bare request. Alone at the root."`
	Chain    *types.ChainRequest    `` /* 205-byte string literal not displayed */
}

type PredictOut struct {
	*descriptor.PredictResult
	Composed *pulse.ComposePredictResult `` /* 276-byte string literal not displayed */
	Facet    *pulse.FacetPredictResult   `` /* 130-byte string literal not displayed */
	Chain    *pulse.ChainPredictResult   `` /* 151-byte string literal not displayed */
	Errors   []*descriptor.EnvelopeEntry `` /* 182-byte string literal not displayed */
	Warnings []*descriptor.EnvelopeEntry `` /* 131-byte string literal not displayed */
}

type ProcessChainIn = types.ChainRequest

type ProcessChainOut = types.ChainResponse

type ProcessIn = types.Request

type ProcessOut = types.Response

type RakeIn struct {
	Cohort      string             `` /* 144-byte string literal not displayed */
	Out         string             `` /* 280-byte string literal not displayed */
	WeightField string             `` /* 267-byte string literal not displayed */
	Margins     []pulse.RakeMargin `` /* 576-byte string literal not displayed */
	By          string             `` /* 198-byte string literal not displayed */
	BaseWeight  string             `` /* 231-byte string literal not displayed */
	Missing     string             `` /* 223-byte string literal not displayed */
	MinWeight   float64            `` /* 144-byte string literal not displayed */
	MaxWeight   float64            `` /* 182-byte string literal not displayed */
	MaxIter     int                `` /* 152-byte string literal not displayed */
	Tol         float64            `` /* 145-byte string literal not displayed */
	Total       float64            `` /* 145-byte string literal not displayed */
	Overwrite   bool               `` /* 293-byte string literal not displayed */
}

type RakeOut = pulse.RakeResult

type RangeTablesIn struct{}

type RangeTablesOut struct {
	Tables []pulse.RangeTableInfo `json:"tables" jsonschema:"Registered range tables (name, range count, ordered labeled date ranges)"`
}

type RecommendIn struct {
	Intent string   `` /* 182-byte string literal not displayed */
	Cohort string   `` /* 209-byte string literal not displayed */
	Fields []string `` /* 217-byte string literal not displayed */
	Level  string   `` /* 155-byte string literal not displayed */
	Limit  int      `` /* 161-byte string literal not displayed */
}

type RecommendOut = descriptor.RecommendResult

type SampleIn struct {
	Path  string `json:"path" jsonschema:"Filesystem path to the .pulse file"`
	Count int    `json:"count,omitempty" jsonschema:"Maximum rows to return (default 10)"`
}

type SampleOut struct {
	Rows []map[string]any `json:"rows" jsonschema:"Sampled rows, each a field-name to value map"`
}

type SkillsGetIn struct {
	Name string `json:"name" jsonschema:"Skill name (e.g. 'aggregation-design')"`
}

type SkillsGetOut struct {
	Body string `json:"body" jsonschema:"Markdown body of the named skill"`
}

type SkillsListIn struct {
	Intent string `` /* 274-byte string literal not displayed */
}

type SkillsListOut struct {
	Skills []skills.Metadata `json:"skills" jsonschema:"Embedded skill-pack entries (name, description, applies_to)"`
}

type ToolDescriptor struct {
	Name         string
	Description  string
	InputSchema  json.RawMessage
	OutputSchema json.RawMessage
	Invoke       InvokeFunc
}

type ToolSchema struct {
	Name         string          `json:"name"`
	Description  string          `json:"description"`
	InputSchema  json.RawMessage `json:"input_schema"`
	OutputSchema json.RawMessage `json:"output_schema"`
}