https://github.com/connery-io/connery-sdk
The open-source SDK for creating AI plugins and actions
https://github.com/connery-io/connery-sdk
actions agent ai ai-actions ai-agent api apps automation chatbot development gpt integration llm middleware natural-language no-code plugins sdk tools
Last synced: 6 months ago
JSON representation
The open-source SDK for creating AI plugins and actions
- Host: GitHub
- URL: https://github.com/connery-io/connery-sdk
- Owner: connery-io
- License: apache-2.0
- Created: 2023-06-20T16:28:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T15:23:43.000Z (over 1 year ago)
- Last Synced: 2024-08-14T15:50:53.047Z (over 1 year ago)
- Topics: actions, agent, ai, ai-actions, ai-agent, api, apps, automation, chatbot, development, gpt, integration, llm, middleware, natural-language, no-code, plugins, sdk, tools
- Language: TypeScript
- Homepage: https://sdk.connery.io
- Size: 68 MB
- Stars: 256
- Watchers: 2
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# The open-source SDK for
creating AI plugins and actions
[](https://github.com/connery-io/connery-sdk/releases)
[](https://github.com/connery-io/connery-sdk/blob/main/LICENSE)
## 🤔 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](https://docs.connery.io/sdk/get-started/core-concepts#plugin) and [actions](https://docs.connery.io/sdk/get-started/core-concepts#action) 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](https://docs.connery.io/sdk/get-started/core-concepts#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](https://docs.connery.io/sdk/get-started/core-concepts#app) 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](https://github.com/connery-io/gmail/blob/main/src/actions/sendEmail.ts)
is an action in the [connery-io/gmail](https://github.com/connery-io/gmail) plugin.
## 🚀 Quickstart
Initialize a new plugin with a sample action:
```bash
npx connery@latest dev init
```
Install the dependencies:
```bash
npm install
```
Run the plugin server:
```bash
npm start
```
[Explore](http://localhost:4201) the plugin in a browser and use it in AI apps.
👉 Check out the [full quickstart guide](https://docs.connery.io/sdk/guides/create-a-plugin) to learn more.
## ✅ Example 1: Send email from an OpenAI GPT
## ✅ Example 2: Summarize a webpage and send it by email from OpenGPTs
## ✅ Example 3: Scale back-end service on AWS from Slack
## 🌟 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.
## 📖 Documentation
Check out the [documentation](https://docs.connery.io/sdk) 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](https://github.com/connery-io/connery-sdk/discussions) - for feedback, questions, and discussions.
- [Issues](https://github.com/connery-io/connery-sdk/issues) - for bug reports and feature requests.
- [Twitter](https://twitter.com/connery_io) - for updates and announcements.
## 🗄️ Repository structure
This is a monorepo that contains the following components:
| Name | Path | Description |
| ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| SDK & CLI | `./packages/connery` | The [`connery`](https://www.npmjs.com/package/connery) package that contains both the SDK and CLI for plugins and actions development. |
| Docs | `./docs` | The [documentation](https://docs.connery.io/sdk) 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](/CONTRIBUTING.md).