GitHub MCP server for AI agents

Let Claude, ChatGPT or your own agent read and act on GitHub: 46 typed functions through one MCP server. No GitHub API key needed.

Functions
46
Sign-in
Not needed
Works with
MCP, HTTP, Node, Python

Connect

Just GitHub

An MCP server for GitHub alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.

https://api.bowmark.ai/mcp/site/github
Every site

One MCP server for GitHub and every other site Bowmark covers. Your agent looks up what it needs and calls it.

https://api.bowmark.ai/mcp
Set it up in your client

Both need a Bowmark API key. The quickstart gets you one and a first result in a few minutes.

Functions

Open a function to see its arguments, what it returns and how to call it.

Read 32
  • compareCommitsCompares two refs of a public repo.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    basestringYes
    headstringYes

    Returns GithubCompareResult

    interface GithubComparedFile {
      filename: string;
      status: string;
      additions: number;
      deletions: number;
      changes: number;
      patch: string | null;
    }
    
    interface GithubCompareResult {
      /** ahead / behind / diverged / identical */
      status: string;
      aheadBy: number;
      behindBy: number;
      totalCommits: number;
      commits: { sha: string; authorName: string; date: string; message: string; url: string }[];
      files: GithubComparedFile[];
      url: string;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/compareCommits

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.compareCommits("octocat", "Hello-World", "master", "test");
  • getFileContentsReads any file in a public repository decoded to text, or lists a directory.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pathstringYes
    options.refstringNo

    Returns GithubFileContents

    interface GithubDirectoryEntry {
      name: string;
      path: string;
      type: string;
      size: number;
      url: string;
    }
    
    interface GithubFileContents {
      kind: "file" | "directory";
      path: string;
      content: string | null;
      size: number;
      url: string;
      downloadUrl: string | null;
      entries: GithubDirectoryEntry[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getFileContents

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getFileContents("octocat", "Hello-World", "README");
  • getIssueReturns the full details of one issue.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes

    Returns GithubIssueDetail

    interface GithubIssue {
      number: number;
      title: string;
      body: string | null;
      creator: string;
      assignees: string[];
      labels: string[];
      state: string;
      comments: number;
      createdAt: string;
      updatedAt: string;
      closedAt: string | null;
      url: string;
    }
    
    interface GithubIssueReactions {
      total: number;
      plusOne: number;
      minusOne: number;
      laugh: number;
      hooray: number;
      confused: number;
      heart: number;
      rocket: number;
      eyes: number;
    }
    
    interface GithubIssueDetail extends GithubIssue {
      locked: boolean;
      closedBy: string | null;
      reactions: GithubIssueReactions;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getIssue

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getIssue("octocat", "Hello-World", 349);
  • getOrganizationReturns an organization's public metadata.

    Arguments

    NameTypeRequired
    orgstringYes

    Returns GithubOrganization

    interface GithubOrganization {
      login: string;
      id: number;
      avatarUrl: string;
      profileUrl: string;
      name: string | null;
      blog: string;
      location: string | null;
      email: string | null;
      description: string | null;
      publicRepos: number;
      createdAt: string;
      updatedAt: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getOrganization

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getOrganization("kubernetes");
  • getProfileReadmeReads a person's GitHub profile.

    Arguments

    NameTypeRequired
    handlestringYes

    Returns GithubProfileReadme

    interface GithubProfileReadme {
      login: string;
      name: string | null;
      company: string | null;
      blog: string | null;
      bio: string | null;
      twitterUsername: string | null;
      profileUrl: string;
      readme: string | null;
      readmeUrl: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getProfileReadme

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getProfileReadme("mattpocock");
  • getPullRequestReturns the full details of one pull request.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullRequestNumbernumberYes

    Returns GithubPullRequestDetail

    interface GithubPullRequest {
      number: number;
      title: string;
      body: string | null;
      creator: string;
      state: string;
      draft: boolean;
      merged: boolean;
      mergedAt: string | null;
      baseBranch: string;
      headBranch: string;
      createdAt: string;
      updatedAt: string;
      closedAt: string | null;
      url: string;
    }
    
    interface GithubPullRequestReactions {
      total: number;
      plusOne: number;
      minusOne: number;
      laugh: number;
      hooray: number;
      confused: number;
      heart: number;
      rocket: number;
      eyes: number;
    }
    
    interface GithubPullRequestDetail extends GithubPullRequest {
      locked: boolean;
      closedBy: string | null;
      reactions: GithubPullRequestReactions;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getPullRequest

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getPullRequest("octocat", "Hello-World", 1);
  • getReadmeReturns a public repository's README decoded to text, whatever its filename.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubReadme

    interface GithubReadme {
      name: string;
      path: string;
      size: number;
      content: string;
      url: string;
      downloadUrl: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getReadme

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getReadme("octocat", "Hello-World");
  • getRepoReturns a public repository's own metadata.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubRepository

    interface GithubRepository {
      name: string;
      description: string | null;
      defaultBranch: string;
      stars: number;
      forks: number;
      openIssues: number;
      language: string | null;
      license: string | null;
      homepage: string | null;
      createdAt: string;
      updatedAt: string;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getRepo

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getRepo("octocat", "Hello-World");
  • getSocialAccountsLists the social links a user put on their profile.

    Arguments

    NameTypeRequired
    usernamestringYes

    Returns GithubSocialAccountsResult

    interface GithubSocialAccount {
      provider: string;   // "twitter", "linkedin", "mastodon", "bluesky", "youtube", … or "generic"
      url: string;
    }
    
    interface GithubSocialAccountsResult {
      login: string;
      accounts: GithubSocialAccount[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getSocialAccounts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getSocialAccounts("erikbern");
  • getSponsorPageReturns a person's public GitHub Sponsors page.

    Arguments

    NameTypeRequired
    handlestringYes

    Returns GithubSponsorPage

    interface GithubSponsorTier {
      /** The tier's monthly price in whole dollars, GitHub Sponsors has no sub-dollar tiers. */
      amount: number;
      /** The tier's own reward text, GitHub's rendered HTML stripped to plain text. */
      description: string;
    }
    
    interface GithubSponsorPage {
      handle: string;
      name: string;
      bio: string | null;
      location: string | null;
      sponsorCount: number;
      tiers: GithubSponsorTier[];
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getSponsorPage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getSponsorPage("mattpocock");
  • getUserReturns a person's public GitHub profile metadata.

    Arguments

    NameTypeRequired
    usernamestringYes

    Returns GithubUser

    interface GithubUser {
      login: string;
      id: number;
      avatarUrl: string;
      profileUrl: string;
      type: string;
      name: string | null;
      company: string | null;
      blog: string;
      location: string | null;
      email: string | null;
      bio: string | null;
      twitterUsername: string | null;
      publicRepos: number;
      followers: number;
      following: number;
      createdAt: string;
      updatedAt: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getUser

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getUser("octocat");
  • getUserRepositoriesLists every public repository a user owns.

    Arguments

    NameTypeRequired
    usernamestringYes
    options.sort"created" | "updated" | "pushed" | "full_name"No
    options.direction"asc" | "desc"No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubGetUserRepositoriesResult

    interface GithubUserRepository {
      name: string;
      fullName: string;
      description: string | null;
      fork: boolean;
      archived: boolean;
      defaultBranch: string;
      stars: number;
      forks: number;
      language: string | null;
      url: string;
      updatedAt: string;
      pushedAt: string | null;
    }
    
    interface GithubGetUserRepositoriesResult {
      repositories: GithubUserRepository[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/getUserRepositories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.getUserRepositories("octocat", { per_page: 2 });
  • listCommitsReturns a repository's commit log.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.shastringNo
    options.sincestringNo
    options.untilstringNo
    options.authorstring
    A login or an email: only commits by that author.
    No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListCommitsResult

    interface GithubCommit {
      sha: string;
      authorName: string;
      authorEmail: string;
      date: string;
      message: string;
      url: string;
      authorLogin?: string | null;  // the GitHub account the commit is linked to, or null
    }
    
    interface GithubListCommitsResult {
      commits: GithubCommit[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listCommits

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listCommits("octocat", "Hello-World", { per_page: 2 });
  • listContributorsLists who has contributed to a public repository, most commits first.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListContributorsResult

    interface GithubContributor {
      login: string;
      id: number;
      type: string;
      contributions: number;
      avatarUrl: string;
      profileUrl: string;
    }
    
    interface GithubListContributorsResult {
      contributors: GithubContributor[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listContributors

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listContributors("octocat", "Hello-World", { per_page: 2 });
  • listIssueCommentsReads the comment thread on an issue or pull request.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes
    options.sincestringNo
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListIssueCommentsResult

    interface GithubIssueComment {
      id: number;
      author: string | null;
      body: string;
      createdAt: string;
      updatedAt: string;
      authorAssociation: string;
      url: string;
    }
    
    interface GithubListIssueCommentsResult {
      comments: GithubIssueComment[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listIssueComments

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listIssueComments("octocat", "Hello-World", 1, { per_page: 2 });
  • listIssuesLists issues on a repository, optionally filtered by state (open/closed), assignee, label, and milestone.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.state"open" | "closed" | "all"No
    options.assigneestringNo
    options.labelsstringNo
    options.milestonestringNo
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListIssuesResult

    interface GithubIssue {
      number: number;
      title: string;
      body: string | null;
      creator: string;
      assignees: string[];
      labels: string[];
      state: string;
      comments: number;
      createdAt: string;
      updatedAt: string;
      closedAt: string | null;
      url: string;
    }
    
    interface GithubListIssuesResult {
      issues: GithubIssue[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listIssues

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listIssues("microsoft", "vscode", { per_page: 30, state: "open" });
  • listMarketplaceActionsLists GitHub Actions available on the marketplace, optionally filtered by category or search query.

    Arguments

    NameTypeRequired
    querystring
    Free-text search, matching GitHub's own marketplace search box.
    No
    categorystring
    A marketplace category slug, e.g. "deployment", "code-quality".
    No
    pagenumber
    1-based page number.
    No

    Returns GithubListMarketplaceActionsResult

    interface GithubMarketplaceAction {
      slug: string;
      name: string;
      description: string;
      listingType: string;  // the site's own labels, read the values off a result, never guess one from prose
      url: string;
    }
    
    interface GithubListMarketplaceActionsResult {
      actions: GithubMarketplaceAction[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listMarketplaceActions

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listMarketplaceActions({ query: "deploy" });
  • listNotificationsLists the signed-in caller's GitHub notifications inbox, 25 per page.

    Arguments

    NameTypeRequired
    querystring
    Github.com's own filter: "is:unread", "reason:mention", "repo:owner/name".
    No
    afterstring
    A previous page's nextCursor.
    No

    Returns GithubListNotificationsResult

    interface GithubNotification {
      id: string;
      repository: string; // "owner/repo"
      number: number | null; // null for a thread with none (a Dependabot alert, a release)
      title: string;
      type: string; // "PullRequest" | "Issue" | "Discussion" | "Commit" | "Release" | "SecurityAlert" | github.com's own thread_type
      reason: string | null; // github.com's words: "author", "mention", "subscribed", "review requested", "security alert", …
      unread: boolean;
      updatedAt: string | null;
      url: string;
    }
    
    interface GithubListNotificationsResult {
      login: string; // the signed-in account
      notifications: GithubNotification[]; // 25 per page, newest first
      totalCount: number | null; // github.com's own total for this filter
      nextCursor: string | null; // null on the last page
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listNotifications

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listNotifications();
  • listOrganizationMembersLists an organization's public members.

    Arguments

    NameTypeRequired
    orgstringYes
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListOrganizationMembersResult

    interface GithubOrgMember {
      login: string;
      id: number;
      avatarUrl: string;
      profileUrl: string;
      type: string;
    }
    
    interface GithubListOrganizationMembersResult {
      members: GithubOrgMember[];   // PUBLIC members only
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listOrganizationMembers

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listOrganizationMembers("kubernetes", { per_page: 5 });
  • listOrganizationRepositoriesLists an organization's public repositories.

    Arguments

    NameTypeRequired
    orgstringYes
    options.type"all" | "public" | "sources" | "forks" | "member"No
    options.sort"created" | "updated" | "pushed" | "full_name"No
    options.direction"asc" | "desc"No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubGetUserRepositoriesResult

    interface GithubUserRepository {
      name: string;
      fullName: string;
      description: string | null;
      fork: boolean;
      archived: boolean;
      defaultBranch: string;
      stars: number;
      forks: number;
      language: string | null;
      url: string;
      updatedAt: string;
      pushedAt: string | null;
    }
    
    interface GithubGetUserRepositoriesResult {
      repositories: GithubUserRepository[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listOrganizationRepositories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listOrganizationRepositories("kubernetes", { per_page: 2 });
  • listPullRequestFilesLists what a pull request changes.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullNumbernumberYes
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListPullRequestFilesResult

    interface GithubPullRequestFile {
      filename: string;
      /** GitHub's own file status: "added", "modified", "removed", "renamed" (also "copied", "changed", "unchanged"). */
      status: string;
      additions: number;
      deletions: number;
      changes: number;
      patch: string | null;
      previousFilename: string | null;
      url: string;
    }
    
    interface GithubListPullRequestFilesResult {
      files: GithubPullRequestFile[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listPullRequestFiles

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listPullRequestFiles("octocat", "Hello-World", 1);
  • listPullRequestsLists pull requests on a repository, optionally filtered by state (open/closed/all), base branch, and head branch.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.state"open" | "closed" | "all"No
    options.basestringNo
    options.headstringNo
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListPullRequestsResult

    interface GithubPullRequest {
      number: number;
      title: string;
      body: string | null;
      creator: string;
      state: string;
      draft: boolean;
      merged: boolean;
      mergedAt: string | null;
      baseBranch: string;
      headBranch: string;
      createdAt: string;
      updatedAt: string;
      closedAt: string | null;
      url: string;
    }
    
    interface GithubListPullRequestsResult {
      pullRequests: GithubPullRequest[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listPullRequests

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listPullRequests("microsoft", "vscode", { per_page: 2, state: "open" });
  • listReleasesReturns a public repository's release history.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListReleasesResult

    interface GithubRelease {
      tag: string;
      name: string;
      draft: boolean;
      prerelease: boolean;
      createdAt: string;
      publishedAt: string | null;
      notes: string;
      url: string;
    }
    
    interface GithubListReleasesResult {
      releases: GithubRelease[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listReleases

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listReleases("microsoft", "TypeScript", { per_page: 2 });
  • listSecurityAdvisoriesLists known security advisories for a package (GitHub's global advisory database) or a repository's own published advisories.

    Arguments

    NameTypeRequired
    ecosystemstring
    Global database: npm, pip, maven, go, rubygems, nuget, composer, rust, …
    No
    packagestring
    Global database: a package name, or name@version to keep only advisories affecting that version.
    No
    ownerstring
    A repository's own published advisories instead.
    No
    repostringNo
    severitystringNo
    per_pagenumberNo

    Returns GithubListSecurityAdvisoriesResult

    interface GithubAdvisory {
      ghsaId: string;
      cveId: string | null;
      severity: string;
      summary: string;
      description: string;
      vulnerabilities: {
        ecosystem: string | null;
        package: string | null;
        vulnerableVersionRange: string | null;
        patchedVersions: string | null;
      }[];
      publishedAt: string | null;
      url: string;
    }
    
    interface GithubListSecurityAdvisoriesResult {
      advisories: GithubAdvisory[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listSecurityAdvisories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listSecurityAdvisories({ ecosystem: "npm", package: "axios", per_page: 2 });
  • listStarredRepositoriesLists repositories the signed-in caller has starred.

    Arguments

    NameTypeRequired
    options{ per_page?: number; page?: number }No

    Returns GithubListStarredRepositoriesResult

    interface GithubStarredRepository {
      name: string;
      fullName: string;
      description: string | null;
      stars: number;
      url: string;
    }
    
    interface GithubListStarredRepositoriesResult {
      login: string; // the signed-in account whose stars these are
      repositories: GithubStarredRepository[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listStarredRepositories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listStarredRepositories();
  • listTopicsLists topics from GitHub's public topics page.

    Arguments

    None.

    Returns GithubListTopicsResult

    interface GithubTopic {
      name: string;
      url: string;
    }
    
    interface GithubListTopicsResult {
      topics: GithubTopic[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listTopics

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listTopics();
  • listTrendingRepositoriesLists repositories trending on GitHub by stars in a time window (daily/weekly/monthly), optionally filtered by language.

    Arguments

    NameTypeRequired
    opts{ since?: "daily" | "weekly" | "monthly"; language?: string }No

    Returns GithubListTrendingRepositoriesResult

    interface GithubTrendingRepository {
      handle: string;
      description: string;
      language: string | null;
      stars: number;
      forks: number;
      trendingStarsToday: number;
      url: string;
    }
    
    interface GithubListTrendingRepositoriesResult {
      since: "daily" | "weekly" | "monthly";
      language: string | null;
      repositories: GithubTrendingRepository[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listTrendingRepositories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listTrendingRepositories();
  • listWorkflowRunsLists a public repo's GitHub Actions workflow runs.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    options.branchstringNo
    options.eventstringNo
    options.statusstring
    A status (completed, in_progress) or a conclusion (success, failure).
    No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubListWorkflowRunsResult

    interface GithubWorkflowRun {
      id: number;
      workflow: string;
      title: string;
      runNumber: number;
      branch: string | null;
      headSha: string;
      event: string;
      status: string | null;  // the site's own labels, read the values off a result, never guess one from prose
      conclusion: string | null;
      createdAt: string;
      updatedAt: string;
      url: string;
    }
    
    interface GithubListWorkflowRunsResult {
      totalCount: number;
      runs: GithubWorkflowRun[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/listWorkflowRuns

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.listWorkflowRuns("axios", "axios", { per_page: 2 });
  • searchCodeSearches for code across public repositories, off github.com's own rendered code-search results page.

    Arguments

    NameTypeRequired
    querystringYes

    Returns GithubSearchCodeResult

    interface GithubSearchCodeResult {
      // github.com's own blackbirdSearchRoute payload, raw, the signed-in field
    
      // from), so this is not narrowed to invented field names. Read it defensively.
      totalCount: number;
      results: unknown[];
      raw: Record<string, unknown>;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/searchCode

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.searchCode("useState");
  • searchIssuesFree-text search over issues and pull requests across GitHub.

    Arguments

    NameTypeRequired
    querystringYes
    options.sort"comments" | "reactions" | "created" | "updated"No
    options.order"asc" | "desc"No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubSearchIssuesResult

    interface GithubIssueSearchHit {
      number: number;
      title: string;
      state: string;
      isPullRequest: boolean;
      author: string | null;
      labels: string[];
      comments: number;
      createdAt: string;
      updatedAt: string;
      closedAt: string | null;
      repository: string;
      url: string;
    }
    
    interface GithubSearchIssuesResult {
      totalCount: number;
      issues: GithubIssueSearchHit[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/searchIssues

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.searchIssues("repo:microsoft/vscode is:issue terminal crash", { per_page: 2 });
  • searchRepositoriesSearches across all public repositories by name, language, topic, star count and other filters.

    Arguments

    NameTypeRequired
    querystringYes
    options.sort"stars" | "forks" | "help-wanted-issues" | "updated"No
    options.order"asc" | "desc"No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubSearchRepositoriesResult

    interface GithubRepositorySearchResult {
      fullName: string;
      owner: string;
      description: string | null;
      stars: number;
      forks: number;
      language: string | null;
      url: string;
      updatedAt: string;
    }
    
    interface GithubSearchRepositoriesResult {
      totalCount: number;
      repositories: GithubRepositorySearchResult[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/searchRepositories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.searchRepositories("stars:>50000 language:typescript", { per_page: 2 });
  • searchUsersSearches GitHub accounts by display name (fullname:), location, followers and other qualifiers.

    Arguments

    NameTypeRequired
    querystringYes
    options.sort"followers" | "repositories" | "joined"No
    options.order"asc" | "desc"No
    options.per_pagenumberNo
    options.pagenumberNo

    Returns GithubSearchUsersResult

    interface GithubUserHit {
      login: string;
      id: number;
      avatarUrl: string;
      profileUrl: string;
      type: string;   // "User" or "Organization"
      score: number;  // GitHub's own relevance score
    }
    
    interface GithubSearchUsersResult {
      totalCount: number;   // GitHub's own match count; may exceed the page
      users: GithubUserHit[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/searchUsers

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.searchUsers("fullname:\"Erik Bernhardsson\"", { per_page: 5 });
Act 14
  • createCommentAdds a comment to an issue or pull request, off github.com's own issue-viewer web mutation (POST…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes
    bodystringYes

    Returns GithubCommentResult

    interface GithubCommentResult {
      comment: { body: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/createComment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.createComment("<owner>", "<repo>", 1, "<body>");
  • createIssueOpens a new issue on a repository, off github.com's own issue-creation mutation (POST /_ghui/issues?queryId=..., the persisted-GraphQL door the…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    titlestringYes
    options{ body?: string; repositoryId?: string }No

    Returns GithubCreateIssueResult

    interface GithubCreateIssueResult {
      issue: { number?: number; title?: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/createIssue

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.createIssue("<owner>", "<repo>", "<title>");
  • createPullRequestOpens a pull request from head into base for the signed-in caller, off github.com's own compare page: it loads…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    titlestringYes
    headstringYes
    basestringYes
    options{ body?: string; draft?: boolean }No

    Returns GithubPullRequestCreated

    interface GithubPullRequestCreated {
      number: number;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/createPullRequest

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.createPullRequest("<owner>", "<repo>", "<title>", "<head>", "<base>");
  • createReviewSubmits a review on a pull request for the signed-in caller (approve, request changes, or comment), off github.com's own review box (PUT…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullNumbernumberYes
    review{ event: 'approve' | 'request_changes' | 'comment'; body?: string; headSha?: string }Yes

    Returns GithubReviewResult

    interface GithubReviewResult {
      repository: string;
      pullNumber: number;
      event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
      submitted: true;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/createReview

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.createReview("<owner>", "<repo>", 1, {});
  • createReviewCommentAdds an inline comment to a line, a line range or a whole file in a pull request's diff for the signed-in caller, off github.com's own Files-changed…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullNumbernumberYes
    comment{ body: string; path: string; line?: number; side?: 'left' | 'right'; startLine?: number; startSide?: 'left' | 'right'; headSha?: string; baseSha?: string }Yes

    Returns GithubReviewCommentResult

    interface GithubReviewCommentResult {
      repository: string;
      pullNumber: number;
      path: string;
      line: number | null; // null for a comment on the whole file
      comment: unknown; // GitHub's own comment payload when the reply carried one, else null
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/createReviewComment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.createReviewComment("<owner>", "<repo>", 1, {});
  • deleteCommentDeletes a comment on an issue or pull request, off github.com's own issue-viewer web mutation (DELETE…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes
    commentIdnumberYes

    Returns GithubCommentResult

    interface GithubCommentResult {
      comment: { body: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/deleteComment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.deleteComment("<owner>", "<repo>", 1, 1);
  • mergePullRequestMerges a pull request into its base branch for the signed-in caller, off github.com's own merge box (POST…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullNumbernumberYes
    options{ mergeMethod?: 'merge' | 'squash' | 'rebase'; commitTitle?: string; commitMessage?: string }No

    Returns GithubMergeResult

    interface GithubMergeResult {
      repository: string;
      pullNumber: number;
      mergeMethod: "MERGE" | "SQUASH" | "REBASE";
      merged: true;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/mergePullRequest

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.mergePullRequest("<owner>", "<repo>", 1);
  • starRepositoryStars a repository for the signed-in caller, off github.com's own star form (POST /{owner}/{repo}/star).

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubStarResult

    interface GithubStarResult {
      repository: string;
      starred: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/starRepository

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.starRepository("<owner>", "<repo>");
  • unstarRepositoryUnstars a repository for the signed-in caller, off github.com's own unstar form (POST /{owner}/{repo}/unstar).

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubStarResult

    interface GithubStarResult {
      repository: string;
      starred: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/unstarRepository

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.unstarRepository("<owner>", "<repo>");
  • unwatchRepositoryStops watching a repository for the signed-in caller, returning it to GitHub's default 'participating and @mentions' state (POST…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubSubscriptionResult

    interface GithubSubscriptionResult {
      repository: string;
      subscription: "subscribed" | "included";
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/unwatchRepository

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.unwatchRepository("<owner>", "<repo>");
  • updateCommentEdits an existing comment on an issue or pull request, off github.com's own issue-viewer web mutation (PATCH…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes
    commentIdnumberYes
    bodystringYes

    Returns GithubCommentResult

    interface GithubCommentResult {
      comment: { body: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/updateComment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.updateComment("<owner>", "<repo>", 1, 1, "<body>");
  • updateIssueRenames an issue's TITLE off github.com's own issue-viewer web mutation (PUT /{owner}/{repo}/issues/{number}/title).

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    issueNumbernumberYes
    updates{ title: string }Yes

    Returns GithubUpdateIssueTitleResult

    interface GithubUpdateIssueTitleResult {
      issue: { title: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/updateIssue

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.updateIssue("<owner>", "<repo>", 1, {});
  • updatePullRequestRenames a pull request's TITLE, off the same issue-viewer web mutation (PUT /{owner}/{repo}/issues/{number}/title) updateIssue uses.

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes
    pullNumbernumberYes
    updates{ title: string }Yes

    Returns GithubUpdateIssueTitleResult

    interface GithubUpdateIssueTitleResult {
      issue: { title: string; [key: string]: unknown };
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/updatePullRequest

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.updatePullRequest("<owner>", "<repo>", 1, {});
  • watchRepositoryWatches a repository (all activity) for the signed-in caller, off github.com's own watch-dropdown mutation (POST /notifications/subscribe…

    Arguments

    NameTypeRequired
    ownerstringYes
    repostringYes

    Returns GithubSubscriptionResult

    interface GithubSubscriptionResult {
      repository: string;
      subscription: "subscribed" | "included";
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/github/watchRepository

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.github.watchRepository("<owner>", "<repo>");

Use it from code