Connery Action Tool

Using this tool, you can integrate individual Connery Action into your LangChain agent.

note

If you want to use more than one Connery Action in your agent, check out the Connery Toolkit documentation.

What is Connery?

Connery is an open-source plugin infrastructure for AI.

With Connery, you can easily create a custom plugin with a set of actions and seamlessly integrate them into your LangChain agent. Connery will take care of critical aspects such as runtime, authorization, secret management, access management, audit logs, and other vital features.

Furthermore, Connery, supported by our community, provides a diverse collection of ready-to-use open-source plugins for added convenience.

Learn more about Connery:

• GitHub: https://github.com/connery-io/connery
• Documentation: https://docs.connery.io

Prerequisites

To use Connery Actions in your LangChain agent, you need to do some preparation:

1. Set up the Connery runner using the Quickstart guide.
2. Install all the plugins with the actions you want to use in your agent.
3. Set environment variables CONNERY_RUNNER_URL and CONNERY_RUNNER_API_KEY so the toolkit can communicate with the Connery Runner.

Example of using Connery Action Tool

Setup

To use the Connery Action Tool you need to install the following official peer dependency:

npm

npm install @langchain/community

Yarn

yarn add @langchain/community

pnpm

pnpm add @langchain/community

tip

See this section for general instructions on installing integration packages.

Usage

In the example below, we fetch action by its ID from the Connery Runner and then call it with the specified parameters.

Here, we use the ID of the Send email action from the Gmail plugin.

info

You can see a LangSmith trace of this example here.

import { ConneryService } from "@langchain/community/tools/connery";
import { ChatOpenAI } from "@langchain/openai";
import { initializeAgentExecutorWithOptions } from "langchain/agents";

// Specify your Connery Runner credentials.
process.env.CONNERY_RUNNER_URL = "";
process.env.CONNERY_RUNNER_API_KEY = "";

// Specify OpenAI API key.
process.env.OPENAI_API_KEY = "";

// Specify your email address to receive the emails from examples below.
const recepientEmail = "test@example.com";

// Get the SendEmail action from the Connery Runner by ID.
const conneryService = new ConneryService();
const sendEmailAction = await conneryService.getAction(
  "CABC80BB79C15067CA983495324AE709"
);

// Run the action manually.
const manualRunResult = await sendEmailAction.invoke({
  recipient: recepientEmail,
  subject: "Test email",
  body: "This is a test email sent by Connery.",
});
console.log(manualRunResult);

// Run the action using the OpenAI Functions agent.
const llm = new ChatOpenAI({ temperature: 0 });
const agent = await initializeAgentExecutorWithOptions([sendEmailAction], llm, {
  agentType: "openai-functions",
  verbose: true,
});
const agentRunResult = await agent.invoke({
  input: `Send an email to the ${recepientEmail} and say that I will be late for the meeting.`,
});
console.log(agentRunResult);

API Reference:

• ConneryService from @langchain/community/tools/connery
• ChatOpenAI from @langchain/openai
• initializeAgentExecutorWithOptions from langchain/agents

note

Connery Action is a structured tool, so you can only use it in the agents supporting structured tools.