orbit

type DSLInput struct {
	ResponseFormatInput
}

type DSLOutput struct {
	toolutil.HintableOutput
	// ResponseFormat echoes the response_format that was asked for ("raw" for
	// the command as a JSON object, "llm" for it as compact text), or nothing
	// when GitLab chose its default, raw.
	ResponseFormat string `json:"response_format,omitempty"`
	// FormattedText is the command as compact text, which is the whole of
	// GitLab's answer when the caller selected the "llm" response format.
	FormattedText string `json:"formatted_text,omitempty"`
	// Name is the name of the Orbit command a query runs as, query_graph,
	// under the key GitLab sends it with.
	Name string `json:"name,omitempty"`
	// Description is the grammar of the query language as the command
	// describes it.
	Description string `json:"description,omitempty"`
	// Parameters is the decoded JSON Schema of the command's input, whose
	// query property is the query text orbit.query sends.
	Parameters any `json:"parameters,omitempty"`
}

type GraphStatusDomain struct {
	// Name is the domain identifier (e.g. "SDLC").
	Name string `json:"name,omitempty"`
	// Items are the per-node-type counts in this domain.
	Items []GraphStatusDomainItem `json:"items,omitempty"`
}

type GraphStatusDomainItem struct {
	// Name is the node-type identifier (e.g. "MergeRequest").
	Name string `json:"name,omitempty"`
	// Count is the number of indexed nodes of this type.
	Count int64 `json:"count"`
}

type GraphStatusIndexing struct {
	// State is the indexing pipeline state (e.g. "indexed", "running", "error").
	State string `json:"state,omitempty"`
	// LastStartedAt is the UTC RFC3339 timestamp of the last indexing run start.
	LastStartedAt string `json:"last_started_at,omitempty"`
	// LastCompletedAt is the UTC RFC3339 timestamp of the last successful indexing run.
	LastCompletedAt string `json:"last_completed_at,omitempty"`
	// LastDurationMs is the duration of the last indexing run in milliseconds.
	LastDurationMs int64 `json:"last_duration_ms,omitempty"`
	// LastError is the last indexing error message, or empty when the
	// last run completed successfully.
	LastError string `json:"last_error,omitempty"`
}

type GraphStatusInput struct {
	// NamespaceID targets a group by ID. Mutually exclusive with ProjectID
	// and FullPath; exactly one of the three must be set.
	NamespaceID int64 `` /* 132-byte string literal not displayed */
	// ProjectID targets a project by ID. Mutually exclusive with
	// NamespaceID and FullPath; exactly one of the three must be set.
	ProjectID int64 `json:"project_id,omitempty" jsonschema:"Project ID to inspect. Set exactly one of namespace_id, project_id, or full_path."`
	// FullPath targets a group or project by full path
	// (e.g. "gitlab-org/gitlab"). Mutually exclusive with NamespaceID
	// and ProjectID; exactly one of the three must be set.
	FullPath string `` /* 143-byte string literal not displayed */
	ResponseFormatInput
}

type GraphStatusOutput struct {
	toolutil.HintableOutput
	// FormattedText is the pre-formatted text body returned by the
	// server when the caller selected the "llm" response format.
	FormattedText string `json:"formatted_text,omitempty"`
	// Projects summarizes the indexed vs. known project counts.
	Projects *GraphStatusProjects `json:"projects,omitempty"`
	// Domains are the per-domain indexing counts.
	Domains []GraphStatusDomain `json:"domains,omitempty"`
	// Indexing is the latest indexing pipeline state.
	Indexing *GraphStatusIndexing `json:"indexing,omitempty"`
}

type GraphStatusProjects struct {
	// Indexed is the number of projects whose Knowledge Graph is
	// up to date in the index.
	Indexed int64 `json:"indexed"`
	// TotalKnown is the total number of projects eligible for indexing.
	TotalKnown int64 `json:"total_known"`
	// Gaps is the number of projects the indexer gave up on: every attempt
	// it is allowed was used and none produced an index (ProjectsStatus.gaps
	// in crates/orbit-server/proto/orbit.proto of
	// gitlab-org/orbit/knowledge-graph). client-go's OrbitGraphStatusProjects
	// does not model it, so [GraphStatus] reads it from the captured response
	// (register row 93 of docs/development/upstream-bugs.md).
	Gaps int64 `json:"gaps"`
}

type QueryInput struct {
	Query any `` /* 958-byte string literal not displayed */
	// ResponseFormat selects the answer's shape. POST /orbit/query declares
	// a third value beside raw and llm, which is why this input carries its
	// own field rather than [ResponseFormatInput] (`values: %w[raw llm gql]`
	// in ee/lib/api/orbit/data.rb):
	//   - "raw": the structured envelope, sent when the field is omitted
	//   - "llm": compact text optimized for LLM consumption
	//   - "gql": the result as a graph pattern table, text like llm
	//
	// "json" is read as "raw", for the reason [ResponseFormatInput] gives.
	ResponseFormat string `` /* 189-byte string literal not displayed */
}

type QueryOutput struct {
	toolutil.HintableOutput
	// FormattedText is the text body returned by the server when the
	// caller selected the "llm" response format, or the graph pattern
	// table of the "gql" one.
	FormattedText string `json:"formatted_text,omitempty"`
	// Result is the decoded result envelope returned for the
	// "raw" response format. Its shape depends on the
	// query_type: traversal returns a list of row objects,
	// aggregation returns aggregation rows, neighbors returns the
	// neighbor expansion, and path_finding returns the matching paths.
	Result any `json:"result,omitempty"`
	// QueryType echoes the query_type that produced this result
	// (traversal, aggregation, neighbors, or path_finding).
	QueryType string `json:"query_type,omitempty"`
	// RawQueryStrings are the SQL strings the server executed for
	// the request; useful for debugging slow or unexpected queries.
	RawQueryStrings []string `json:"raw_query_strings,omitempty"`
	// RowCount is the number of rows in the result envelope.
	RowCount int64 `json:"row_count,omitempty"`
}

type ResponseFormatInput struct {
	// ResponseFormat selects the Orbit response shape. GitLab declares
	// two values on every route that takes it (ee/lib/api/orbit/data.rb,
	// `values: %w[raw llm]`):
	//   - "raw": structured JSON
	//   - "llm": compact text optimized for LLM consumption
	//
	// "json" is accepted here as a synonym of "raw" and sent as "raw":
	// GitLab answers 400 "response_format does not have a valid value"
	// to it on every route, and it was offered here as a value of its
	// own until that was measured.
	//
	// When empty the parameter is not sent and GitLab applies its own
	// default, which is "raw" on every route.
	ResponseFormat string `` /* 144-byte string literal not displayed */
}

type SchemaDomain struct {
	// Name is the domain identifier (e.g. "core", "sdlc").
	Name string `json:"name,omitempty"`
	// Description is the human-readable domain summary.
	Description string `json:"description,omitempty"`
	// NodeNames are the ontology node types in the domain.
	NodeNames []string `json:"node_names,omitempty"`
}

type SchemaEdge struct {
	// Name is the edge type identifier (e.g. "AUTHORED", "IN_PROJECT").
	Name string `json:"name,omitempty"`
	// Description is the human-readable edge summary.
	Description string `json:"description,omitempty"`
	// Variants are the valid source/target node-type pairs.
	Variants []SchemaEdgeVariant `json:"variants,omitempty"`
}

type SchemaEdgeVariant struct {
	// SourceType is the source node type (e.g. "User").
	SourceType string `json:"source_type,omitempty"`
	// TargetType is the target node type (e.g. "Issue").
	TargetType string `json:"target_type,omitempty"`
}

type SchemaInput struct {
	// Expand lists node names whose full properties and relationships
	// should be hydrated in the response.
	Expand []string `json:"expand,omitempty" jsonschema:"Node names to expand with full properties and relationships."`
	// Format selects the schema response shape: "raw" or "llm", with
	// "json" read as "raw" for the reason [ResponseFormatInput] gives.
	// Empty leaves GitLab's default ("raw"). Whichever of the two
	// input names carries it, it reaches GitLab as response_format,
	// which is the only name the route declares.
	Format string `` /* 142-byte string literal not displayed */
	// ResponseFormat is an alias for Format, under the name GitLab
	// declares for the parameter. Must match Format when both are set.
	ResponseFormat string `json:"response_format,omitempty" jsonschema:"Alias for format. Must match format when both are set."`
}

type SchemaOutput struct {
	toolutil.HintableOutput
	// FormattedText is the ontology as compact text, which is the whole
	// of GitLab's answer when the caller selected the "llm" response
	// format. client-go's OrbitSchema does not model the key, so it is
	// read from the captured response.
	FormattedText string `json:"formatted_text,omitempty"`
	// SchemaVersion is the Orbit ontology version string.
	SchemaVersion string `json:"schema_version,omitempty"`
	// Domains are the logical groupings of node types.
	Domains []SchemaDomain `json:"domains,omitempty"`
	// Nodes are the decoded node-type definitions. The Orbit API
	// evolves the node shape, so the SDK exposes the list as raw JSON
	// values rather than fixed Go types.
	Nodes []any `json:"nodes,omitempty"`
	// Edges are the graph edge types.
	Edges []SchemaEdge `json:"edges,omitempty"`
}

type StatusComponent struct {
	// Name is the subsystem identifier (e.g. "clickhouse", "api").
	Name string `json:"name,omitempty"`
	// Status is the subsystem health label (e.g. "healthy").
	Status string `json:"status,omitempty"`
	// Replicas are the ready/desired counts, or nil when the
	// subsystem is stateless.
	Replicas *StatusReplicas `json:"replicas,omitempty"`
	// Metrics is the decoded raw JSON metrics payload for the subsystem.
	Metrics any `json:"metrics,omitempty"`
}

type StatusInput struct {
	ResponseFormatInput
}

type StatusOutput struct {
	toolutil.HintableOutput
	// User mirrors the user-level access object from the nested
	// response shape, or nil for the flat shape.
	User *StatusUser `json:"user,omitempty"`
	// System mirrors the cluster health object from the nested
	// response shape, or nil for the flat shape.
	System *StatusSystem `json:"system,omitempty"`
	// FormattedText is the pre-formatted text body returned by the
	// server when the caller selected the "llm" response format.
	FormattedText string `json:"formatted_text,omitempty"`
	// Status is the cluster-level health label.
	Status string `json:"status,omitempty"`
	// Timestamp is the server-side snapshot time, RFC3339.
	Timestamp string `json:"timestamp,omitempty"`
	// Version is the Orbit service version.
	Version string `json:"version,omitempty"`
	// Components are the per-subsystem status entries.
	Components []StatusComponent `json:"components,omitempty"`
}

type StatusReplicas struct {
	// Ready is the current number of healthy replicas.
	Ready int64 `json:"ready"`
	// Desired is the target number of replicas.
	Desired int64 `json:"desired"`
}

type StatusSystem struct {
	// FormattedText is the pre-formatted text body, when present.
	FormattedText string `json:"formatted_text,omitempty"`
	// Status is the cluster-level health label.
	Status string `json:"status,omitempty"`
	// Timestamp is the server-side snapshot time, RFC3339.
	Timestamp string `json:"timestamp,omitempty"`
	// Version is the Orbit service version.
	Version string `json:"version,omitempty"`
	// Error is the backend error message emitted when the gRPC
	// cluster is unreachable, or empty otherwise.
	Error string `json:"error,omitempty"`
	// Components are the per-subsystem status entries.
	Components []StatusComponent `json:"components,omitempty"`
}

type StatusUser struct {
	// Available reports whether the calling user has access to the
	// Knowledge Graph.
	Available bool `json:"available"`
}

type ToolDefinition struct {
	// Name is the tool name as Orbit exposes it.
	Name string `json:"name,omitempty"`
	// Description is the tool's human-readable description.
	Description string `json:"description,omitempty"`
	// Parameters is the decoded JSON Schema for the tool's input.
	Parameters any `json:"parameters,omitempty"`
}

type ToolsInput struct{}

type ToolsOutput struct {
	toolutil.HintableOutput
	// Tools is the list of MCP tools Orbit exposes.
	Tools []ToolDefinition `json:"tools,omitempty"`
}