docs[patch]: add toolkit template (#24791)

2025-08-09 21:08:59 +00:00 · 2024-07-30 12:36:09 -04:00 · 2024-07-30 12:36:09 -04:00 · 73ec24fc56
commit 73ec24fc56
parent b3e1378f2b
5 changed files with 737 additions and 514 deletions
--- a/docs/docs/integrations/toolkits/index.mdx
+++ b/docs/docs/integrations/toolkits/index.mdx
@ -0,0 +1,21 @@
+---
+sidebar_position: 0
+sidebar_class_name: hidden
+---
+
+# Toolkits
+
+**Toolkits** are collections of tools that are designed to be used together for specific tasks. They include conveniences for loading tools
+that share common authentication, services, or other objects. They can be implemented by subclassing the
+[BaseToolkit](https://api.python.langchain.com/en/latest/tools/langchain_core.tools.BaseToolkit.html#langchain_core.tools.BaseToolkit) class.
+
+This table lists common toolkits.
+
+
+| Namespace 🔻 | Class |
+|------------|---------|
+| langchain_community.agent_toolkits.github | [GitHubToolkit](https://api.python.langchain.com/en/latest/agent_toolkits/langchain_community.agent_toolkits.github.toolkit.GitHubToolkit.html) |
+| langchain_community.agent_toolkits.gmail | [GmailToolkit](https://api.python.langchain.com/en/latest/agent_toolkits/langchain_community.agent_toolkits.gmail.toolkit.GmailToolkit.html) |
+| langchain_community.agent_toolkits.openapi | [RequestsToolkit](https://api.python.langchain.com/en/latest/agent_toolkits/langchain_community.agent_toolkits.openapi.toolkit.RequestsToolkit.html) |
+| langchain_community.agent_toolkits.slack | [SlackToolkit](https://api.python.langchain.com/en/latest/agent_toolkits/langchain_community.agent_toolkits.slack.toolkit.SlackToolkit.html) |
+| langchain_community.agent_toolkits.sql | [SQLDatabaseToolkit](https://api.python.langchain.com/en/latest/agent_toolkits/langchain_community.agent_toolkits.sql.toolkit.SQLDatabaseToolkit.html) |
--- a/docs/docs/integrations/toolkits/sql_database.ipynb
+++ b/docs/docs/integrations/toolkits/sql_database.ipynb
--- a/libs/cli/langchain_cli/integration_template/docs/toolkits.ipynb
+++ b/libs/cli/langchain_cli/integration_template/docs/toolkits.ipynb
@ -0,0 +1,201 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "id": "afaf8039",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "sidebar_label: __ModuleName__\n",
+    "---"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e49f1e0d",
+   "metadata": {},
+   "source": [
+    "# __ModuleName__Toolkit\n",
+    "\n",
+    "- TODO: Make sure API reference link is correct.\n",
+    "\n",
+    "This will help you getting started with the __ModuleName__ [toolkit](/docs/concepts/#toolkits). For detailed documentation of all __ModuleName__Toolkit features and configurations head to the [API reference](https://api.python.langchain.com/en/latest/agent_toolkits/__module_name__.agent_toolkits.__ModuleName__.toolkit.__ModuleName__Toolkit.html).\n",
+    "\n",
+    "## Setup\n",
+    "\n",
+    "- TODO: Update with relevant info."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "72ee0c4b-9764-423a-9dbf-95129e185210",
+   "metadata": {},
+   "source": [
+    "If you want to get automated tracing from runs of individual tools, you can also set your [LangSmith](https://docs.smith.langchain.com/) API key by uncommenting below:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a15d341e-3e26-4ca3-830b-5aab30ed66de",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# os.environ[\"LANGSMITH_API_KEY\"] = getpass.getpass(\"Enter your LangSmith API key: \")\n",
+    "# os.environ[\"LANGSMITH_TRACING\"] = \"true\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0730d6a1-c893-4840-9817-5e5251676d5d",
+   "metadata": {},
+   "source": [
+    "### Installation\n",
+    "\n",
+    "This toolkit lives in the `__package_name__` package:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "652d6238-1f87-422a-b135-f5abbb8652fc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%pip install -qU __package_name__"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a38cde65-254d-4219-a441-068766c0d4b5",
+   "metadata": {},
+   "source": [
+    "## Instantiation\n",
+    "\n",
+    "Now we can instantiate our toolkit:\n",
+    "\n",
+    "- TODO: Update model instantiation with relevant params."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "cb09c344-1836-4e0c-acf8-11d13ac1dbae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from __module_name__ import __ModuleName__Toolkit\n",
+    "\n",
+    "toolkit = __ModuleName__Toolkit(\n",
+    "    # ...\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5c5f2839-4020-424e-9fc9-07777eede442",
+   "metadata": {},
+   "source": [
+    "## Tools\n",
+    "\n",
+    "View available tools:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "51a60dbe-9f2e-4e04-bb62-23968f17164a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "toolkit.get_tools()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d11245ad-3661-4405-8558-1188896347ec",
+   "metadata": {},
+   "source": [
+    "TODO: list API reference pages for individual tools."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "dfe8aad4-8626-4330-98a9-7ea1ca5d2e0e",
+   "metadata": {},
+   "source": [
+    "## Use within an agent"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "310bf18e-6c9a-4072-b86e-47bc1fcca29d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langgraph.prebuilt import create_react_agent\n",
+    "\n",
+    "agent_executor = create_react_agent(llm, tools)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "23e11cc9-abd6-4855-a7eb-799f45ca01ae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "example_query = \"...\"\n",
+    "\n",
+    "events = agent_executor.stream(\n",
+    "    {\"messages\": [(\"user\", example_query)]},\n",
+    "    stream_mode=\"values\",\n",
+    ")\n",
+    "for event in events:\n",
+    "    event[\"messages\"][-1].pretty_print()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d1ee55bc-ffc8-4cfa-801c-993953a08cfd",
+   "metadata": {},
+   "source": [
+    "## TODO: Any functionality or considerations specific to this toolkit\n",
+    "\n",
+    "Fill in or delete if not relevant."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3a5bb5ca-c3ae-4a58-be67-2cd18574b9a3",
+   "metadata": {},
+   "source": [
+    "## API reference\n",
+    "\n",
+    "For detailed documentation of all __ModuleName__Toolkit features and configurations head to the [API reference](https://api.python.langchain.com/en/latest/agent_toolkits/__module_name__.agent_toolkits.__ModuleName__.toolkit.__ModuleName__Toolkit.html)."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
--- a/libs/cli/langchain_cli/integration_template/integration_template/toolkits.py
+++ b/libs/cli/langchain_cli/integration_template/integration_template/toolkits.py
@ -0,0 +1,71 @@
+"""__ModuleName__ chat models."""
+
+from typing import List
+from langchain_core.tools import BaseTool, BaseToolKit
+
+
+class __ModuleName__Toolkit(BaseToolKit):
+    # TODO: Replace all TODOs in docstring. See example docstring:
+    # https://github.com/langchain-ai/langchain/blob/a6d1fb4275801a4850e62b6209cfbf096a24f93f/libs/community/langchain_community/agent_toolkits/sql/toolkit.py#L20
+    """__ModuleName__ toolkit.
+
+    # TODO: Replace with relevant packages, env vars, etc.
+    Setup:
+        Install ``__package_name__`` and set environment variable ``__MODULE_NAME___API_KEY``.
+
+        .. code-block:: bash
+
+            pip install -U __package_name__
+            export __MODULE_NAME___API_KEY="your-api-key"
+
+    # TODO: Populate with relevant params.
+    Key init args:
+        arg 1: type
+            description
+        arg 2: type
+            description
+
+    # TODO: Replace with relevant init params.
+    Instantiate:
+        .. code-block:: python
+
+            from __package_name__ import __ModuleName__Toolkit
+
+            toolkit = __ModuleName__Toolkit(
+                # ...
+            )
+
+    Tools:
+        .. code-block:: python
+
+            toolkit.get_tools()
+
+        .. code-block:: python
+
+            # TODO: Example output.
+
+    Use within an agent:
+        .. code-block:: python
+
+            from langgraph.prebuilt import create_react_agent
+
+            agent_executor = create_react_agent(llm, tools)
+
+            example_query = "..."
+
+            events = agent_executor.stream(
+                {"messages": [("user", example_query)]},
+                stream_mode="values",
+            )
+            for event in events:
+                event["messages"][-1].pretty_print()
+
+        .. code-block:: python
+
+             # TODO: Example output.
+
+    """  # noqa: E501
+
+    # TODO: This method must be implemented to generate chat responses.
+    def get_tools(self) -> List[BaseTool]:
+        raise NotImplementedError()
--- a/libs/community/langchain_community/agent_toolkits/sql/toolkit.py
+++ b/libs/community/langchain_community/agent_toolkits/sql/toolkit.py
@ -17,12 +17,63 @@ from langchain_community.utilities.sql_database import SQLDatabase


 class SQLDatabaseToolkit(BaseToolkit):
-    """Toolkit for interacting with SQL databases.
+    """SQLDatabaseToolkit for interacting with SQL databases.

-    Parameters:
-        db: SQLDatabase. The SQL database.
-        llm: BaseLanguageModel. The language model.
-    """
+    Setup:
+        Install ``langchain-community``.
+
+        .. code-block:: bash
+
+            pip install -U langchain-community
+
+    Key init args:
+        db: SQLDatabase
+            The SQL database.
+        llm: BaseLanguageModel
+            The language model (for use with QuerySQLCheckerTool)
+
+    Instantiate:
+        .. code-block:: python
+
+            from langchain_community.agent_toolkits.sql.toolkit import SQLDatabaseToolkit
+            from langchain_community.utilities.sql_database import SQLDatabase
+            from langchain_openai import ChatOpenAI
+
+            db = SQLDatabase.from_uri("sqlite:///Chinook.db")
+            llm = ChatOpenAI(temperature=0)
+
+            toolkit = SQLDatabaseToolkit(db=db, llm=llm)
+
+    Tools:
+        .. code-block:: python
+
+            toolkit.get_tools()
+
+    Use within an agent:
+        .. code-block:: python
+
+            from langchain import hub
+            from langgraph.prebuilt import create_react_agent
+
+            # Pull prompt (or define your own)
+            prompt_template = hub.pull("langchain-ai/sql-agent-system-prompt")
+            system_message = prompt_template.format(dialect="SQLite", top_k=5)
+
+            # Create agent
+            agent_executor = create_react_agent(
+                llm, toolkit.get_tools(), state_modifier=system_message
+            )
+
+            # Query agent
+            example_query = "Which country's customers spent the most?"
+
+            events = agent_executor.stream(
+                {"messages": [("user", example_query)]},
+                stream_mode="values",
+            )
+            for event in events:
+                event["messages"][-1].pretty_print()
+    """  # noqa: E501

    db: SQLDatabase = Field(exclude=True)
    llm: BaseLanguageModel = Field(exclude=True)