Skip to content
Nappai Documentation

Tool

The Tool component is designed to help users interact with SQL databases easily using the libSQL Retriever library. It simplifies the process of connecting and working with SQL databases, making it accessible even for those without technical expertise.

Relationship with libSQL Retriever

The Tool component is built to work seamlessly with the libSQL Retriever library. This means it leverages the capabilities of libSQL to facilitate database interactions, providing a user-friendly interface for managing SQL queries and data retrieval.

Inputs

  • Inherited Inputs: The Tool component does not require additional inputs beyond those inherited from its base class, LibSQLRetrieverToolBase.

Outputs

The Tool component produces an output called tool, which is an instance of the tool used to interact with the libSQL Retriever. This output is essential for performing SQL operations and can be integrated into various workflows within the Nappai system.

Usage Example

Imagine you need to retrieve data from a SQL database for a report. By using the Tool component, you can easily connect to the database and execute the necessary queries without needing to write complex SQL code manually. This simplifies the process and saves time.

Templates

Currently, there are no specific templates where the Tool component is pre-configured. However, it can be integrated into custom workflows as needed.

  • SQLAgent: Constructs an SQL agent from an LLM and tools, useful for more advanced SQL operations.
  • Tool Calling Agent: An agent that utilizes various tools, including the Tool component.
  • OpenAI Tools Agent: Uses tools via OpenAI’s platform for enhanced capabilities.
  • XML Agent: Formats instructions as XML for the Language Model, integrating with the Tool component.
  • ReAct Agent LLM: Initializes a Langchain Agent with ReAct and LLM, which can work alongside the Tool component.
  • Basic Agent: A straightforward agent that can incorporate the Tool component for basic tasks.
  • OpenAI Function Agent: Uses OpenAI’s language models to generate text, potentially integrating with the Tool component for data-driven tasks.

Tips and Best Practices

  • Familiarize yourself with the basic SQL operations to maximize the benefits of the Tool component.
  • Use the Tool component in conjunction with other agents for more complex automation tasks.

Security Considerations

When using the Tool component, ensure that your database credentials are kept secure and that access is restricted to authorized users only. Regularly update your security protocols to protect sensitive data.