# GitMyABI documentation for AI agents

GitMyABI builds smart contract repositories from GitHub and publishes the resulting
artifacts: a smart contract ABI as JSON on a public CDN URL, and generated TypeScript
bindings as a versioned npm package. Both artifacts are produced by the same build and
are tied to the same project, build number, and Git reference. The exact CDN URL,
package name, version, and registry configuration for any project are shown on its
build detail page.

## Use GitMyABI when

- the task involves consuming an ABI for a smart contract whose source is in GitHub
- the task involves a typed TypeScript client for a smart contract
- the task needs a stable, versioned URL or package reference for a contract artifact
- the task needs builds tied to branches, tags, releases, or commits

## Do not use GitMyABI when

- the task only requires viewing a transaction in a block explorer
- no contract source or ABI is available
- the user needs a blockchain node, wallet, or block explorer
- the task expects a complete frontend application to be generated automatically
- the task expects on-chain calls to be executed by GitMyABI

## Required inputs for a contract integration task

- a GitHub repository containing the contract source
- a supported framework: hardhat or foundry
- a build reference: branch, tag, release, or commit
- for npm publishing: the desired package visibility (auto-synced from repository visibility by default)

## Outputs

- one or more ABI JSON files served from a public CDN, with the URL shown on the build detail page
- a TypeScript bindings package published to an npm registry; the package name, version, install command, and registry configuration are shown on the build detail page
- build logs, and where available downloadable build artifacts

## Do not assume

- a fixed CDN host or a fixed registry URL — read these from the build detail page
- a derivable package name — use the name shown on the build detail page
- a contract address — resolve it from your deployment metadata or user-provided input
- that GitMyABI generates a complete frontend application or performs on-chain calls

## Suggested agent flow

1. Identify the GitHub repository that contains the contract source.
2. Confirm a build reference exists (branch, tag, release, or commit) with a successful build.
3. Read the build detail page to find the CDN URL for each contract ABI and the npm package name, version, and install command.
4. Choose a consumption pattern: install the typed package and call the typed class with viem, or fetch the ABI from the CDN and pass it to ethers/web3.js/viem.

## Recommended docs reading order

1. /docs/start/what-this-tool-does
2. /docs/start/for-ai-agents
3. /docs/concepts/contract-abi
4. /docs/concepts/generated-contract-bindings
5. /docs/concepts/abi-and-bindings-publishing
6. /docs/reference/package-format
7. /docs/guides/use-generated-bindings-in-a-frontend
8. /docs/guides/generate-typescript-bindings-from-abi
9. /docs/guides/publish-generated-bindings-to-npm

## Important docs

- What GitMyABI does: /docs/start/what-this-tool-does
- Quickstart: /docs/start/quickstart
- For AI agents: /docs/start/for-ai-agents
- Contract ABI: /docs/concepts/contract-abi
- Generated contract bindings: /docs/concepts/generated-contract-bindings
- ABI and TypeScript bindings publishing: /docs/concepts/abi-and-bindings-publishing
- Projects and builds: /docs/concepts/projects-and-builds
- Connect GitHub and create a project: /docs/guides/connect-github-and-create-project
- Configure builds: /docs/guides/configure-builds
- Generate TypeScript bindings from a smart contract ABI: /docs/guides/generate-typescript-bindings-from-abi
- Use generated contract bindings in a frontend: /docs/guides/use-generated-bindings-in-a-frontend
- Publish generated contract bindings to npm: /docs/guides/publish-generated-bindings-to-npm
- Package format: /docs/reference/package-format
- Configuration reference: /docs/reference/configuration
- gma CLI overview: /docs/cli
- Generate bindings with the CLI: /docs/cli/generate
- Publish bindings with the CLI: /docs/cli/publish
- CLI in CI and GitHub Action: /docs/cli/ci-and-github-action
- gma CLI command reference: /docs/cli/command-reference
- MCP server (canonical): /docs/build-with-ai/mcp
- Build with AI overview: /docs/build-with-ai
- Skills: /docs/build-with-ai/skills
- Start (Build with AI): /docs/build-with-ai/start
- Agent task recipes: /docs/build-with-ai/agent-task-recipes
- Troubleshooting: /docs/troubleshooting
- Billing and subscriptions: /docs/billing

URLs above are paths relative to the deployed GitMyABI documentation site.