Documentation
¶
Index ¶
- type DataObjectFieldBrief
- 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 DataObjectFieldBrief ¶
type DataObjectQuery ¶
type DataObjectSearchItem ¶
type DataObjectSearchItem struct {
Name string `json:"name" jsonschema_description:"Full type name (e.g. prefix_tablename)"`
Module string `json:"module" jsonschema_description:"Module path (e.g. sales.analytics)"`
Description string `json:"description"`
ObjectType string `json:"object_type" jsonschema_description:"table or view"`
Score float64 `json:"score"`
Queries []DataObjectQuery `json:"queries" jsonschema_description:"Available query fields in module namespace"`
Fields []DataObjectFieldBrief `json:"fields,omitempty" jsonschema_description:"Top fields (scalars and relations)"`
}
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 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"`
Description string `json:"description"`
IsMutation bool `json:"is_mutation"`
IsList bool `json:"is_list" jsonschema_description:"Returns array"`
Score float64 `json:"score"`
Arguments []FunctionArgument `json:"arguments"`
Returns FunctionReturnType `json:"returns"`
}
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.