Skip to content

connery-io/connery-sdk

Repository files navigation

The open-source SDK for
creating AI plugins and actions

Release License

🤔 What is Connery SDK?

Connery SDK is an NPM package that includes both an SDK and a CLI, designed for the development of plugins and actions.

The CLI automates many things in the development process. Meanwhile, the SDK offers a JavaScript API for defining plugins and actions and packaging them into a plugin server with a standardized REST API generated from the metadata. The plugin server handles authorization, input validation, and logging. So you can focus on the logic of your actions.

The standardized API enables various clients to interact with actions in a unified way, regardless of the underlying implementation.

An action consists of JavaSctipt code that defines its logic and metadata that describes its input and output. The action can communicate with external APIs, databases, or other services.

👉 Example: Send email is an action in the connery-io/gmail plugin.

Connery diagram

🚀 Quickstart

Initialize a new plugin with a sample action:

npx connery@latest dev init

Install the dependencies:

npm install

Run the plugin server:

npm start

Open the plugin in the browser: localhost:4201.

👉 Check out the full quickstart guide to learn more.

✅ Example 1: Send email from an OpenAI GPT

Send email from an OpenAI GPT

👉 Learn more: OpenAI GPT client.

✅ Example 2: Summarize a webpage and send it by email from OpenGPTs

Summarize a webpage and send it by email from OpenGPTs

👉 Learn more: LangChain OpenGPTs client.

✅ Example 3: Scale back-end service on AWS from Slack

Scheduled scaling of Back End service on AWS Fargate from Slack using Connery

👉 Learn more: Slack client.

🌟 Support us and stay up-to-date

Please give the repository a star to support the project and stay up-to-date with the latest news.

Give the repository a star

💡 Use cases

🌳 Ecosystem

We aim to build a community-driven ecosystem of open-source plugins and clients. So, anyone can benefit from the shared knowledge and resources to accelerate innovation.

Below are manually curated lists of open-source plugins built with Connery SDK and clients for interacting with them:

📖 Documentation

Check out the documentation to learn more.

💬 Feedback & Support

Connery is still in early beta, so not everything is perfect yet. Please let us know of any suggestions, ideas, or bugs you encounter, and we will use your feedback to improve our upcoming releases.

You can reach us via the following channels:

  • Discussions - for feedback, questions, and discussions.
  • Issues - for bug reports and feature requests.
  • Discord - for community collaboration.
  • Twitter - for updates and announcements.

🗄️ Repository structure

This is a monorepo that contains the following components:

Name Path Description
SDK & CLI ./packages/connery The connery package that contains both the SDK and CLI for plugins and actions development.
Docs ./apps/docs The documentation website.

👨‍💻 Contributing

We are open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.

For detailed information on how to contribute, see our contributing guide.