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 the caller chose none and the handler asked for 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 GraphStatusAccess struct {
	// State is the group's access state, GitLab's OrbitAccessState: LICENSED,
	// TRIAL_ACTIVE, TRIAL_ELIGIBLE, TRIAL_ENDED, TRIAL_NOT_ELIGIBLE,
	// TRIAL_STATUS_UNAVAILABLE, UNLICENSED or NOT_CONFIGURED.
	State string `json:"state"`
	// Reason is the cause of a state that has more than one, GitLab's
	// OrbitAccessReason: where the access of a LICENSED group comes from
	// (PLAN, PROMO_ADD_ON or BETA), or why a group has none (FREE_PLAN,
	// NO_LICENSE, NO_ACCESS, TRIAL_EXPIRED or CREDITS_EXHAUSTED). Absent when
	// the state has one cause, for which GitLab sends null.
	Reason string `json:"reason,omitempty"`
	// TurnOnDenialReason is why the token's user cannot turn Orbit on for the
	// group, GitLab's OrbitTurnOnDenialReason: FORBIDDEN, TRIAL_REQUIRED,
	// PURCHASE_REQUIRED, TRIAL_ENDED or UNAVAILABLE. Absent when turning Orbit
	// on is allowed or it is already on.
	TurnOnDenialReason string `json:"turn_on_denial_reason,omitempty"`
}

type GraphStatusArea struct {
	// Name is the area (e.g. "source_code").
	Name string `json:"name,omitempty"`
	// State is the area's indexing state.
	State string `json:"state,omitempty"`
}

type GraphStatusDomain struct {
	// Name is the domain (e.g. "code_review").
	Name string `json:"name,omitempty"`
	// Items are the counts of each entity in the domain.
	Items []GraphStatusDomainItem `json:"items,omitempty"`
}

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

type GraphStatusIndexing struct {
	// State is the indexing state: READY, INDEXING, NOT_STARTED, FAILED or
	// UNKNOWN.
	State string `json:"state,omitempty"`
	// LastCompletedAt is when Orbit last completed indexing the group or
	// project, empty until the first run completes.
	LastCompletedAt string `json:"last_completed_at,omitempty"`
	// Areas are the indexing states of each area.
	Areas []GraphStatusArea `json:"areas,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 `json:"namespace_id,omitempty" jsonschema:"Group ID to inspect. Set exactly one of namespace_id, project_id, or full_path."`
	// 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 */
	StructuredFormatInput
}

type GraphStatusOutput struct {
	toolutil.HintableOutput
	// Enabled reports whether Orbit is turned on for the group's top-level
	// group; absent for a project, for which GitLab sends null.
	Enabled *bool `json:"enabled,omitempty"`
	// EnabledAt is when Orbit was turned on for the top-level group.
	EnabledAt string `json:"enabled_at,omitempty"`
	// Access is the Orbit access state of a top-level group, GitLab's
	// OrbitNamespace.access. GitLab answers it for a top-level group alone,
	// and null for a subgroup, a project and a token that cannot read the
	// group's Orbit setting, which takes the Owner role, so it is absent
	// there: the top-level group's full_path reports it to an Owner. An index
	// absent under a state other than LICENSED or TRIAL_ACTIVE is absent
	// because of the access ([GraphStatusAccess.Serves]).
	Access *GraphStatusAccess `json:"access,omitempty"`
	// Trial is the Orbit trial of a top-level group, GitLab's
	// OrbitNamespace.trial: null, and so absent, for a subgroup, a project, a
	// token that cannot read the trial, and when GitLab could not read it
	// from CustomersDot.
	Trial *GraphStatusTrial `json:"trial,omitempty"`
	// Projects is the indexing progress of the projects, GitLab's
	// indexing.projects. It, Domains and Indexing are absent when GitLab
	// serves no index: a group without Orbit access, Orbit turned off, or a
	// token below the Reporter role there.
	Projects *GraphStatusProjects `json:"projects,omitempty"`
	// Domains are the indexed item counts of each domain, GitLab's
	// itemCounts.domains.
	Domains []GraphStatusDomain `json:"domains,omitempty"`
	// Indexing is the indexing state.
	Indexing *GraphStatusIndexing `json:"indexing,omitempty"`
}

type GraphStatusProjects struct {
	// Indexed is the number of indexed projects.
	Indexed int64 `json:"indexed"`
	// TotalKnown is the number of projects known to Orbit.
	TotalKnown int64 `json:"total_known"`
	// Gaps is the number of projects that are not indexed, as GitLab's
	// gaps field counts them.
	Gaps int64 `json:"gaps"`
	// NotIndexed is the number of projects that are not indexed, as
	// GitLab's notIndexed field counts them.
	NotIndexed int64 `json:"not_indexed"`
	// Total is the number of projects known to Orbit, as GitLab's total
	// field counts them.
	Total int64 `json:"total"`
}

type GraphStatusTrial struct {
	// State is the trial's state, GitLab's OrbitTrialState: ELIGIBLE,
	// NOT_ELIGIBLE, ACTIVE or ENDED.
	State string `json:"state"`
	// ExpiresOn is the last day of the trial, in UTC; absent before a trial
	// starts.
	ExpiresOn string `json:"expires_on,omitempty"`
	// Credits are the trial's credits.
	Credits *GraphStatusTrialCredits `json:"credits,omitempty"`
	// Offer is the terms of a new trial, absent unless the token's user can
	// start one and CustomersDot sends valid terms.
	Offer *GraphStatusTrialOffer `json:"offer,omitempty"`
}

type GraphStatusTrialCredits struct {
	// Remaining is the number of trial credits left.
	Remaining *float64 `json:"remaining,omitempty"`
	// Total is the number of credits granted to the trial.
	Total *float64 `json:"total,omitempty"`
}

type GraphStatusTrialOffer struct {
	// DurationDays is the number of days a new trial lasts.
	DurationDays *int64 `json:"duration_days,omitempty"`
	// InitialCredits is the number of free credits a new trial starts with.
	InitialCredits *float64 `json:"initial_credits,omitempty"`
}

type QueryInput struct {
	Query string `` /* 1303-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 answer's shape. GitLab declares two values
	// (the format property of list_commands' input schema):
	//   - "raw": structured JSON
	//   - "llm": compact text optimized for LLM consumption
	//
	// "json" is accepted here as a synonym of "raw" and sent as "raw": it was
	// offered here as a value of its own until GitLab's refusal of it was
	// measured on the REST routes this action read before.
	//
	// When empty the handler asks for "raw", the default of the REST route
	// this action read until GitLab.com removed it on 2026-10-28; the MCP tool
	// defaults to llm.
	ResponseFormat string `json:"response_format,omitempty" jsonschema:"Response format: raw or llm (json is read as raw). When omitted, raw."`
}

type SchemaDomain struct {
	// Name is the domain identifier (e.g. "core", "source_code").
	Name string `json:"name,omitempty"`
	// NodeNames are the node kinds in the domain.
	NodeNames []string `json:"node_names,omitempty"`
}

type SchemaEdge struct {
	// Name is the edge kind, which a query uses as the relationship type
	// (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 pairs of node kinds the edge connects, GitLab's
	// endpoints.
	Variants []SchemaEdgeVariant `json:"variants,omitempty"`
}

type SchemaEdgeVariant struct {
	// SourceType is the node kind at the start of the edge (e.g. "User").
	SourceType string `json:"source_type,omitempty"`
	// TargetType is the node kind at the end of the edge (e.g. "Issue").
	TargetType string `json:"target_type,omitempty"`
}

type SchemaInput struct {
	// Expand lists node names whose properties should be included in the
	// response. Without it the schema lists every node kind and edge kind
	// without the properties, which is most of the answer's size.
	Expand []string `` /* 162-byte string literal not displayed */
	// Format selects the schema response shape: "raw" (GitLab's GraphQL
	// schema, the default) or "llm" (the compact text the get_graph_schema
	// command of GitLab's Orbit MCP endpoint answers), with "json" read as
	// "raw". Whichever of the two input names carries it, it means the same.
	Format string `` /* 134-byte string literal not displayed */
	// ResponseFormat is an alias for Format. 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 SchemaNode struct {
	// Name is the node kind, which a query uses as the node label.
	Name string `json:"name"`
	// Description is the human-readable node summary.
	Description string `json:"description,omitempty"`
	// Domain is the domain the node kind belongs to.
	Domain string `json:"domain,omitempty"`
	// PrimaryKey is the property that identifies a node.
	PrimaryKey string `json:"primary_key,omitempty"`
	// LabelField is the property shown as a node's label, GitLab's
	// labelProperty.
	LabelField string `json:"label_field,omitempty"`
	// Display is how GitLab draws nodes of the kind.
	Display *SchemaNodeDisplay `json:"display,omitempty"`
	// Properties are the node kind's properties, present only for the
	// nodes named in expand.
	Properties []SchemaProperty `json:"properties,omitempty"`
}

type SchemaNodeDisplay struct {
	// Color is the hex color of the node kind.
	Color string `json:"color,omitempty"`
	// Size is the relative size of the node kind in a graph.
	Size int64 `json:"size,omitempty"`
}

type SchemaOutput struct {
	toolutil.HintableOutput
	// FormattedText is the schema as compact text, which is the whole of
	// GitLab's answer when the caller selected the "llm" format.
	FormattedText string `json:"formatted_text,omitempty"`
	// Domains are the domains of the node kinds, each with its nodes.
	Domains []SchemaDomain `json:"domains,omitempty"`
	// Nodes are the node kinds.
	Nodes []SchemaNode `json:"nodes,omitempty"`
	// Edges are the edge kinds.
	Edges []SchemaEdge `json:"edges,omitempty"`
}

type SchemaProperty struct {
	// Name is the property name.
	Name string `json:"name"`
	// DataType is the property's data type, for example String or Int.
	DataType string `json:"data_type,omitempty"`
	// Nullable reports whether the property can be empty.
	Nullable bool `json:"nullable"`
	// EnumValues are the values an enum property takes, empty otherwise.
	EnumValues []string `json:"enum_values,omitempty"`
}

type StatusComponent struct {
	// Name is the component, for example "clickhouse-graph" or "nats".
	Name string `json:"name,omitempty"`
	// Status is the component's health state, GitLab's
	// OrbitServiceComponent.state: HEALTHY, DEGRADED, UNHEALTHY, MIGRATING
	// or UNKNOWN.
	Status string `json:"status,omitempty"`
}

type StatusInput struct {
	StructuredFormatInput
}

type StatusOutput struct {
	toolutil.HintableOutput
	// Status is the overall health state of the Orbit service: HEALTHY,
	// DEGRADED, UNHEALTHY, MIGRATING or UNKNOWN.
	Status string `json:"status,omitempty"`
	// Version is the Orbit service version.
	Version string `json:"version,omitempty"`
	// Components are the health states of the service's components.
	Components []StatusComponent `json:"components,omitempty"`
}

type StructuredFormatInput struct {
	// ResponseFormat is raw, llm or json, all answered with the structured
	// output. It is checked and not sent: GitLab's GraphQL API has no llm
	// rendering of the Orbit status or of a namespace's index.
	ResponseFormat string `` /* 200-byte string literal not displayed */
}

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, which
	// MCP's tools/list answers as inputSchema.
	Parameters any `json:"parameters,omitempty"`
	// Trusted is the trust flag GitLab sends beside each tool, absent when
	// GitLab sends none.
	Trusted *bool `json:"trusted,omitempty"`
}

type ToolsInput struct{}

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