octocode-mcp/dist/src/github/githubAPI.d.ts

Model Context Protocol (MCP) server for advanced GitHub repository analysis and code discovery. Provides AI assistants with powerful tools to search, analyze, and understand codebases across GitHub.

import type { components } from '@octokit/openapi-types';
import type { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
export type Repository = components['schemas']['full-repository'];
export type CodeSearchResultItem = components['schemas']['code-search-result-item'];
export type RepoSearchResultItem = components['schemas']['repo-search-result-item'];
export type IssueSearchResultItem = components['schemas']['issue-search-result-item'];
export type DiffEntry = components['schemas']['diff-entry'];
export interface CommitFileItem {
    filename: string;
    status: string;
    additions: number;
    deletions: number;
    changes: number;
    patch?: string;
}
/** Commit file change information */
export interface CommitFileInfo {
    filename: string;
    status: string;
    additions: number;
    deletions: number;
    changes?: number;
    patch?: string;
}
/** Commit information with file changes */
export interface CommitInfo {
    sha: string;
    message: string;
    author: string;
    date: string;
    files: CommitFileInfo[];
}
export type GetContentParameters = RestEndpointMethodTypes['repos']['getContent']['parameters'];
export type GetRepoResponse = RestEndpointMethodTypes['repos']['get']['response'];
export type SearchCodeParameters = RestEndpointMethodTypes['search']['code']['parameters'];
export type SearchCodeResponse = RestEndpointMethodTypes['search']['code']['response'];
export type SearchReposParameters = RestEndpointMethodTypes['search']['repos']['parameters'];
export interface GitHubAPIError {
    error: string;
    status?: number;
    type: 'http' | 'graphql' | 'network' | 'unknown';
    scopesSuggestion?: string;
    rateLimitRemaining?: number;
    rateLimitReset?: number;
    retryAfter?: number;
}
export interface GitHubAPISuccess<T> {
    data: T;
    status: number;
    headers?: Record<string, string>;
}
export type GitHubAPIResponse<T> = GitHubAPISuccess<T> | GitHubAPIError;
export type RepositoryReference = {
    owner: string;
    repo: string;
    ref?: string;
};
export type OptimizedCodeSearchResult = {
    items: Array<Pick<CodeSearchResultItem, 'path' | 'url'> & {
        matches: Array<{
            context: string;
            positions: [number, number][];
        }>;
        repository: {
            nameWithOwner: string;
            url: string;
        };
        minificationType?: string;
    }>;
    total_count: number;
    repository?: {
        name: string;
        url: string;
    };
    securityWarnings?: string[];
    minified?: boolean;
    minificationFailed?: boolean;
    minificationTypes?: string[];
    _researchContext?: {
        foundPackages: string[];
        foundFiles: string[];
        repositoryContext?: {
            owner: string;
            repo: string;
        };
    };
};
export type GitHubPullRequestItem = Pick<IssueSearchResultItem, 'number' | 'title' | 'body' | 'state' | 'created_at' | 'updated_at' | 'closed_at' | 'url' | 'draft'> & {
    author: string;
    labels: string[];
    merged_at?: string;
    comments?: Array<{
        id: string;
        author: {
            login: string;
        };
        authorAssociation: string;
        body: string;
        createdAt: string;
        includesCreatedEdit: boolean;
        isMinimized: boolean;
        minimizedReason: string;
        reactionGroups: unknown[];
        url: string;
        viewerDidAuthor: boolean;
    }>;
    reactions: number;
    head?: string;
    base?: string;
    head_sha?: string;
    base_sha?: string;
    file_changes?: {
        total_count: number;
        files: DiffEntry[];
    };
    commits?: CommitInfo[];
    _sanitization_warnings?: string[];
};
export interface GitHubPullRequestsSearchParams {
    query?: string;
    owner?: string | string[];
    repo?: string | string[];
    prNumber?: number;
    state?: 'open' | 'closed';
    draft?: boolean;
    merged?: boolean;
    author?: string;
    assignee?: string;
    mentions?: string;
    commenter?: string;
    involves?: string;
    'reviewed-by'?: string;
    'review-requested'?: string;
    head?: string;
    base?: string;
    created?: string;
    updated?: string;
    'merged-at'?: string;
    closed?: string;
    comments?: number | string;
    reactions?: number | string;
    interactions?: number | string;
    label?: string | string[];
    'no-assignee'?: boolean;
    'no-label'?: boolean;
    'no-milestone'?: boolean;
    'no-project'?: boolean;
    match?: ('title' | 'body' | 'comments')[];
    sort?: 'created' | 'updated' | 'best-match';
    order?: 'asc' | 'desc';
    limit?: number;
    withComments?: boolean;
    withCommits?: boolean;
    type?: 'metadata' | 'fullContent' | 'partialContent';
    partialContentMetadata?: {
        file: string;
        additions?: number[];
        deletions?: number[];
    }[];
    exhaustive?: boolean;
    maxPages?: number;
    pageSize?: number;
}
export declare function isGitHubAPIError(obj: unknown): obj is GitHubAPIError;
export declare function isGitHubAPISuccess<T>(obj: unknown): obj is GitHubAPISuccess<T>;
export declare function isRepository(obj: unknown): obj is Repository;