Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Codacy

Scalekit connector
Open markdown

The Codacy connector lets your AI agent act in each user's Codacy account. Each user connects their own Codacy API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
47 · 12 · 147 read12 write1 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Codacy connection

    In AgentKit > Connections, create a Codacy connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'codacy'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Codacy:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'codacy_tools_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Codacy credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • codacy_category_overviews_listGet the number of Codacy issues per category, such as Security or Code Style, for a branch.Read-only

    List Category Overviews

    Get the number of Codacy issues per category, such as Security or Code Style, for a branch. Returns each category with its issue count and share. Use Search Issues to list the issues.

    Inputs

    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
    branchstring
    Branch name; defaults to the repository's main branch. Example: main.
  • codacy_coding_standard_getGet one Codacy coding standard.Read-only

    Get Coding Standard

    Get one Codacy coding standard. Returns its name, languages, enabled tools and linked repository count. Use List Coding Standards to find the ID.

    Inputs

    coding_standard_idintegerrequired
    Coding standard ID, from List Coding Standards. Example: 12.
    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
  • codacy_coding_standards_listList the coding standards (shared tool and pattern configurations) of a Codacy organization.Read-only

    List Coding Standards

    List the coding standards (shared tool and pattern configurations) of a Codacy organization. Returns each standard's id, name, default flag and languages. Use Apply Coding Standard to link repositories.

    Inputs

    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
  • codacy_commit_delta_issues_listList the issues a commit added or fixed compared with its parent or another commit.Read-only

    List Commit Delta Issues

    List the issues a commit added or fixed compared with its parent or another commit. Returns each issue's status (new or fixed), pattern, severity, file and line. Set targetCommitUuid to compare two commits.

    Inputs

    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
    src_commit_uuidstringrequired
    Commit SHA to inspect. Example: 2957025d42e8daadf937d4044516f991d21deea4.
    cursorstring
    Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
    limitinteger
    Maximum number of items to return, 1 to 100. Example: 20.
    only_potentialboolean
    Set to `true` to return only potential issues. Example: false.
    statusstring
    Filter issues by status. Valid values are `all`, `new`, or `fixed`. Example: new.one of allnewfixed
    target_commit_uuidstring
    Commit SHA to compare with; defaults to the parent commit. Example: 1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d.
  • codacy_commit_delta_statistics_getGet the quality changes a commit introduced in Codacy.Read-only

    Get Commit Delta Statistics

    Get the quality changes a commit introduced in Codacy. Returns new and fixed issue counts and complexity, duplication and coverage variation. Use Get Commit Analysis for the full commit view.

    Inputs

    commit_uuidstringrequired
    Commit SHA, from List Repository Commits. Example: 2957025d42e8daadf937d4044516f991d21deea4.
    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
  • codacy_commit_getGet the Codacy analysis of one commit.Read-only

    Get Commit Analysis

    Get the Codacy analysis of one commit. Returns new and fixed issues, complexity, duplication and coverage deltas. Use List Commit Delta Issues for the issues.

    Inputs

    commit_uuidstringrequired
    Commit SHA, from List Repository Commits. Example: 2957025d42e8daadf937d4044516f991d21deea4.
    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
  • codacy_commit_statistics_listGet daily Codacy analysis statistics of a repository branch for recent days.Read-only

    List Commit Statistics

    Get daily Codacy analysis statistics of a repository branch for recent days. Returns per-day issues, complexity, duplication and coverage numbers. Use it to chart quality over time.

    Inputs

    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
    branchstring
    Branch name; defaults to the repository's main branch. Example: main.
    daysinteger
    Number of days of data to return (1-365, defaults to 31). Example: 30.
  • codacy_commits_listList the analyzed commits of a Codacy repository branch.Read-only

    List Repository Commits

    List the analyzed commits of a Codacy repository branch. Returns each commit's SHA, author, message, date and quality deltas. Use Get Commit Analysis for one commit.

    Inputs

    providerstringrequired
    Git provider of the organization: gh (GitHub), gl (GitLab) or bb (Bitbucket). Example: gh.one of ghglbb
    remote_organization_namestringrequired
    Organization name on the Git provider, as in its URL, e.g. codacy. Example: codacy.
    repository_namestringrequired
    Repository name inside the organization, e.g. awesome-repo. Example: awesome-repo.
    branchstring
    Branch name; defaults to the repository's main branch. Example: main.
    cursorstring
    Cursor for the next page, from the previous response's pagination.cursor. Omit for the first page. Example: Yms345gh==.
    limitinteger
    Maximum number of items to return, 1 to 100. Example: 20.