Skip to main content

GitHub Issues Tool

Description​

The GitHub Issues tool integrates with GitHub's API to fetch issues from specified repositories. It provides a clean, structured way to retrieve and analyze repository issues.

GitHub Issues Tool

Try it in the Kaiban Board!

Want to see this tool in action? Check out our interactive Kaiban Board! Try it now!

Enhance your agents with:

  • Issue Collection: Fetch open issues from any public GitHub repository
  • Automatic Pagination: Handle large sets of issues seamlessly
  • Structured Data: Get well-formatted issue details and metadata
  • Flexible Authentication: Work with or without GitHub tokens

Installation​

First, install the KaibanJS tools package:

npm install @kaibanjs/tools

API Key​

A GitHub Personal Access Token is optional but recommended:

Example​

Here's how to use the GitHub Issues tool:

import { GithubIssues } from '@kaibanjs/tools';

// Configure GitHub tool
const githubTool = new GithubIssues({
    token: 'github_pat_...', // Optional: higher rate limits with token
    limit: 20 // Optional: number of issues to fetch
});

// Create issue collector agent
const issueCollector = new Agent({
    name: 'Luna',
    role: 'Issue Collector',
    goal: 'Gather and organize GitHub issues efficiently',
    background: 'Specialized in data collection from GitHub repositories',
    tools: [githubTool]
});

// Create a team
const team = new Team({
    name: 'GitHub Issue Analysis Team',
    agents: [issueCollector],
    tasks: [/* your tasks */],
    inputs: {
        repository: 'https://github.com/owner/repo'
    }
});

Parameters​

  • token Optional. GitHub Personal Access Token for higher rate limits
    • Without token: 60 requests/hour
    • With token: 5,000 requests/hour
  • limit Optional. Number of issues to fetch per request. Default is 10.

Rate Limits​

  • Authenticated: 5,000 requests per hour
  • Unauthenticated: 60 requests per hour

For more information about GitHub's API, visit: GitHub REST API Documentation

We Love Feedback!

Is there something unclear or quirky in the docs? Maybe you have a suggestion or spotted an issue? Help us refine and enhance our documentation by submitting an issue on GitHub. We're all ears!