Documentation
¶
Index ¶
- type ArgInputField
- type DataObjectQuery
- type DataObjectSearchItem
- type DataSourceSearchItem
- type EnumValueInfo
- type EnumValuesResult
- type FieldArgumentInfo
- type FieldStats
- type FieldValueCount
- type FieldValuesResult
- type FunctionArgument
- type FunctionReturnField
- type FunctionReturnType
- type FunctionSearchItem
- type ModuleSearchItem
- type SearchResult
- type Server
- type TypeFieldInfo
- type TypeInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArgInputField ¶ added in v0.3.35
type DataObjectQuery ¶
type DataObjectQuery struct {
Name string `json:"name" jsonschema_description:"Query field name in module (e.g. orders, orders_by_pk)"`
QueryType string `json:"query_type" jsonschema_description:"select, select_one, aggregate, bucket_agg"`
ReturnType string `` /* 131-byte string literal not displayed */
QueryRoot string `` /* 195-byte string literal not displayed */
Arguments []FunctionArgument `` /* 144-byte string literal not displayed */
}
type DataObjectSearchItem ¶
type DataObjectSearchItem struct {
Name string `` /* 129-byte string literal not displayed */
ObjectType string `json:"object_type" jsonschema_description:"table or view"`
Parameterized bool `` /* 150-byte string literal not displayed */
HasGeometry bool `json:"has_geometry" jsonschema_description:"true when the object has at least one geometry field"`
Module string `json:"module" jsonschema_description:"Module path the object lives in — REQUIRED to nest the GraphQL query"`
Catalog string `json:"catalog" jsonschema_description:"Data source (catalog) name the object belongs to"`
Description string `json:"description"`
FieldsCount int `json:"fields_count" jsonschema_description:"Number of fields on the object type"`
Queries []DataObjectQuery `json:"queries" jsonschema_description:"Available query fields in the module namespace"`
Score float64 `json:"score"`
}
type DataSourceSearchItem ¶
type EnumValueInfo ¶
type EnumValuesResult ¶
type EnumValuesResult struct {
Name string `json:"name" jsonschema_description:"Enum type name"`
Description string `json:"description" jsonschema_description:"Enum type description"`
Values []EnumValueInfo `json:"values" jsonschema_description:"List of enum values"`
}
type FieldArgumentInfo ¶
type FieldStats ¶
type FieldValueCount ¶
type FieldValuesResult ¶
type FieldValuesResult struct {
Stats *FieldStats `json:"stats,omitempty"`
Values []FieldValueCount `json:"values,omitempty"`
}
type FunctionArgument ¶
type FunctionArgument struct {
Name string `json:"name"`
Type string `json:"type"`
Required bool `json:"required"`
Desc string `json:"description,omitempty"`
// Fields expands an input-object argument into its input fields.
// Populated by describe_data_objects for the `args` argument of a
// parameterized view (the view's parameters); empty otherwise.
Fields []ArgInputField `` /* 176-byte string literal not displayed */
}
type FunctionReturnField ¶
type FunctionReturnType ¶
type FunctionReturnType struct {
TypeName string `json:"type_name"`
IsList bool `json:"is_list"`
Fields []FunctionReturnField `json:"fields,omitempty" jsonschema_description:"Top fields of return type (up to 10)"`
}
type FunctionSearchItem ¶
type FunctionSearchItem struct {
Name string `json:"name" jsonschema_description:"Function field name in module"`
Module string `json:"module" jsonschema_description:"Module the function lives in — REQUIRED to nest the GraphQL call"`
Description string `json:"description,omitempty"`
IsMutation bool `json:"is_mutation"`
IsList bool `json:"is_list" jsonschema_description:"Returns array"`
// Lean search fields.
ReturnType string `` /* 143-byte string literal not displayed */
ArgumentsCount int `` /* 138-byte string literal not displayed */
Score float64 `json:"score,omitempty"`
// Full detail — set by discovery-describe_functions only.
Arguments []FunctionArgument `json:"arguments,omitempty"`
Returns *FunctionReturnType `json:"returns,omitempty"`
}
type ModuleSearchItem ¶
type SearchResult ¶
type SearchResult[T any] struct { Total int `json:"total" jsonschema_description:"Total matching items in database"` Returned int `json:"returned" jsonschema_description:"Items returned in this page"` Items []T `json:"items"` }
SearchResult is a generic paginated wrapper for tool responses.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server wraps the MCP server and its dependencies.
type TypeFieldInfo ¶
type TypeFieldInfo struct {
Name string `json:"name"`
FieldType string `json:"field_type" jsonschema_description:"Full GraphQL type (e.g. String!, [Int])"`
HugrType string `json:"hugr_type" jsonschema_description:"select=relation, aggregate, bucket_agg, extra_field, function"`
IsList bool `json:"is_list"`
Description string `json:"description,omitempty"`
ArgsCount int `json:"arguments_count"`
Arguments []FieldArgumentInfo `json:"arguments,omitempty"`
Score float64 `json:"score,omitempty"`
}
type TypeInfo ¶
type TypeInfo struct {
Name string `json:"name"`
Kind string `json:"kind" jsonschema_description:"OBJECT, INPUT_OBJECT, ENUM, SCALAR"`
Module string `json:"module"`
HugrType string `json:"hugr_type" jsonschema_description:"table, view, module, filter, data_input, etc"`
Catalog string `json:"catalog"`
FieldsTotal int `json:"fields_total"`
HasGeometryField bool `json:"has_geometry_field"`
HasFieldWithArgs bool `json:"has_field_with_arguments"`
Description string `json:"description,omitempty"`
LongDescription string `json:"long_description,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.