Awesome
<div align="center">The open-source SDK for<br>creating AI plugins and actions
🤔 What is Connery SDK?
The Connery SDK is an NPM package that combines an SDK and a CLI, designed to streamline the development of plugins and actions for AI apps.
The CLI automates the development process, while the SDK provides a JavaScript API for defining plugins and actions. It also simplifies packaging them into a plugin server with a standardized REST API generated from metadata. The plugin server takes care of authorization, input validation, and logging, allowing you to focus on the core logic of your actions.
This standardized API ensures that various apps can interact with actions in a consistent way, regardless of their implementation.
An action consists of JavaScript code that defines its logic and metadata describing its input and output. Actions can interact with external APIs, databases, or other services.
For example, Send email is an action in the connery-io/gmail plugin.
<div align="center"> <img width="550px" alt="Connery diagram" src="./img/connery-sdk.png"> </div>🚀 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
Explore the plugin in a browser and use it in AI apps.
👉 Check out the full quickstart guide to learn more.
✅ Example 1: Send email from an OpenAI GPT
<img alt="Send email from an OpenAI GPT" src="./img/send-email-from-a-custom-gpt-using-connery-actions.gif">✅ Example 2: Summarize a webpage and send it by email from OpenGPTs
<img alt="Summarize a webpage and send it by email from OpenGPTs" src="./img/summarize-a-webpage-and-send-it-by-email-from-opengpts.gif">✅ Example 3: Scale back-end service on AWS from Slack
<img alt="Scheduled scaling of Back End service on AWS Fargate from Slack using Connery" src="./img/scheduled-scaling-of-back-end-service-on-aws-fargate-from-slack-using-connery.gif">🌟 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.
<img src="./img/give-us-a-star.png" alt="Give the repository a star" width="300">📖 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.
- 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 | ./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.