sql

func (*Tool) Execute ¶

func (t *Tool) Execute(ctx context.Context, req *tool.ExecutionRequest) (any, error)

Execute executes the SQL tool with the provided request.

Summary: Executes the SQL query with the given inputs.

Parameters:

• ctx (context.Context): The context for the request.
• req (*tool.ExecutionRequest): The execution request containing parameters.

Returns:

• any: The query results (a list of row maps).
• error: An error if execution fails.

Errors:

• Returns an error if policy evaluation fails or blocks execution.
• Returns an error if input unmarshalling fails.
• Returns an error if the database query fails.

Side Effects:

• Executes a query on the database.

func (*Tool) GetCacheConfig ¶

func (t *Tool) GetCacheConfig() *configv1.CacheConfig

GetCacheConfig returns the cache configuration for the tool.

Returns:

• *configv1.CacheConfig: The result.

Side Effects:

• None.

Summary: Retrieves GetCacheConfig operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Tool) IsStreaming ¶

func (t *Tool) IsStreaming() bool

Execute runs the SQL query with the provided inputs.

Parameters:

• ctx (context.Context): The context for the request.
• req (*tool.ExecutionRequest): The parameter.

Returns:

• any: The result.
• error: An error if the operation fails.

Errors:

• Returns an error if ...

Side Effects:

• None.

Summary: Executes Execute operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

IsStreaming returns true if the tool supports streaming.

Summary: Checks if the tool supports streaming execution.

Returns:

• bool: True if streaming is supported.

func (*Tool) MCPTool ¶

func (t *Tool) MCPTool() *mcp.Tool

MCPTool returns the MCP tool definition.

Returns:

• *mcp.Tool: The result.

Side Effects:

• None.

Summary: Executes MCPTool operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Tool) StreamExecute ¶

func (t *Tool) StreamExecute(ctx context.Context, req *tool.ExecutionRequest) (<-chan any, error)

StreamExecute executes the tool in streaming mode.

Summary: Executes the tool in streaming mode.

Parameters:

• ctx: context.Context. The context for the request.
• req: *ExecutionRequest. The request object containing parameters.

Returns:

• <-chan any: A channel that emits streaming results.
• error: An error if the operation fails or streaming is not supported.

func (*Tool) Tool ¶

func (t *Tool) Tool() *v1.Tool

Tool returns the protobuf definition of the tool.

Returns:

• *v1.Tool: The result.

Side Effects:

• None.

Summary: Executes Tool operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Upstream) Register ¶

func (u *Upstream) Register(
	ctx context.Context,
	serviceConfig *configv1.UpstreamServiceConfig,
	toolManager tool.ManagerInterface,
	_ prompt.ManagerInterface,
	_ resource.ManagerInterface,
	_ bool,
) (string, []*configv1.ToolDefinition, []*configv1.ResourceDefinition, error)

Register discovers and registers tools from the SQL configuration. ctx is the context for the request. serviceConfig is the serviceConfig. toolManager is the toolManager. _ is an unused parameter. _ is an unused parameter. _ is an unused parameter. Returns the result. Returns the result. Returns the result. Returns an error if the operation fails.

Parameters:

• ctx (context.Context): The context for the request.
• serviceConfig (*configv1.UpstreamServiceConfig): The serviceConfig parameter.
• toolManager (tool.ManagerInterface): The toolManager parameter.
• _ (prompt.ManagerInterface): The _ parameter.
• _ (resource.ManagerInterface): The _ parameter.
• _ (bool): The _ parameter.

Returns:

• string: The resulting string.
• []*configv1.ToolDefinition: The resulting []*configv1.ToolDefinition.
• []*configv1.ResourceDefinition: The resulting []*configv1.ResourceDefinition.
• error: An error if the operation fails.

Errors:

• Returns an error if the operation fails or is invalid.

Side Effects:

• None

Summary: Executes Register operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.

func (*Upstream) Shutdown ¶

func (u *Upstream) Shutdown(_ context.Context) error

Shutdown closes the database connection.

Parameters:

• _ (context.Context): The parameter.

Returns:

• error: An error if the operation fails.

Errors:

• Returns an error if ...

Side Effects:

• None.

Summary: Executes Shutdown operation.

Parameters:

• TODO: Document parameters.

Returns:

• TODO: Document returns.

Errors:

• TODO: Document errors.

Side Effects:

• None.