@kaibanjs/tools NPM

Kaiban Tools for AI Agents

This package provides a collection of specialized tools designed for use with AI agents, enhancing their capabilities for various tasks.

Purpose

The Kaiban Tools package offers a set of tools that can be integrated into AI agent systems, allowing agents to perform a wide range of tasks more effectively. These tools are designed to extend the capabilities of AI agents, enabling them to interact with external services, process data, and perform complex operations.

Features

A collection of tools specifically designed for AI agents
Easy integration with existing agent frameworks and architectures
Tools for various purposes, including web scraping, data transformation, and more
Configurable options for each tool to suit different agent requirements

Installation

npm install @kaibanjs/tools

Available Tools

Here's a list of all available tools. Click on the tool names to view their detailed documentation.

Tool	Description	Documentation
Exa	AI-focused search engine using embeddings to organize web data	README
Firecrawl	Web scraping service for extracting structured data	README
GitHub Issues	GitHub API integration for fetching and analyzing repository issues	README
Jina URL to MD	Convert web content into clean, LLM-ready markdown using Jina.ai	README
PDF Search	Extract and search content from PDF documents	README
Serper	Google Search API integration with support for multiple search types	README
Simple RAG	Basic Retrieval-Augmented Generation implementation for Q&A	README
Tavily Search	AI-optimized search engine for comprehensive and accurate results	README
Text File Search	Search and analyze content within text files	README
Website Search	Semantic search within website content using RAG models	README
WolframAlpha	Computational intelligence engine for complex queries and calculations	README
Zapier Webhook	Integration with Zapier for workflow automation	README
Make Webhook	Integration with Make (formerly Integromat) for workflow automation	README

Development

Local Setup

Clone the repository:

git clone https://github.com/kaiban-ai/KaibanJS.git

Install KaibanJS dependencies:

npm install

Build the package:

npm run build

Navigate to the tools package:

cd packages/tools

Install dependencies:

npm install

Environment Variables:

Create a .env file in the root directory with your API keys:

VITE_FIRECRAWL_API_KEY=your_firecrawl_api_key
VITE_TAVILY_API_KEY=your_tavily_api_key
VITE_SERPER_API_KEY=your_serper_api_key
VITE_EXA_API_KEY=your_exa_api_key
VITE_WOLFRAM_APP_ID=your_wolfram_app_id

Run Storybook to view and test components:

npm run storybook

Build the package:

npm run build

Run tests:

npm run test

Contributing

To contribute a new tool:

Follow the Development steps above to set up your local environment
Use an existing tool as reference (check src/firecrawl or src/tavily for examples)
Remember to create:
- Your tool implementation
- A Storybook story
- Tests

For questions or discussions, join our Discord.