Impact GatePRODUCT DOCUMENTATION
Understand your
API changes.
Connect your workspace, review downstream impact, and follow the evidence behind every report.
START HERE
Your first Impact Gate report
From sign-in and repository setup to an automatic pull request report.
Follow the quickstart01
Welcome to Impact GateUnderstand your API dependencies and review the impact of a contract change before merging.Set up your first workspaceConnect GitHub, index your repositories, and review your first automatic report.Sign in and manage your accountUse Google or a passwordless email link, return to your workspace, and manage connected sign-in methods.Get started
02
Connect the GitHub AppInstall Impact Gate, verify organization access, and connect the intended installation to your workspace.Select and index repositoriesBuild a useful workspace by indexing API providers and the applications that consume them.Connect Prometheus or DatadogBring existing request metrics and APM observations into your repository API inventory.Connect an AI client to Impact GateCopy-paste setup for connecting Claude, Claude Code, Cursor, VS Code, or ChatGPT to the hosted Impact Gate MCP server.Connect & index
03
Read pull request reportsInterpret the Impact Gate check, contract changes, consumer evidence, and coverage notes.Use the engineering overviewMonitor repository analysis and investigate the latest open pull request findings.Explore APIs and code flowsInspect discovered APIs, request and response schemas, code flows, consumer evidence, and contract changes.Explore the dependency graphExplore repositories and their modules, inspect dependency evidence, and export a workspace snapshot.Use Retirement RadarAssess static, runtime, and measured function evidence, record a review for the current snapshot, and plan removals with service owners.Review changes
04
Configure your workspaceControl default-branch synchronization, PR comments, and retained analysis history.Supported contracts and coveragePrepare contracts for analysis and understand which evidence the current release can establish.Permissions and data handlingUnderstand workspace roles, repository scope, usage analytics, contact requests, and retention controls.Troubleshoot common issuesResolve sign-in failures, missing repositories, partial indexing, and missing or outdated PR reports.Workspace web API referenceUnderstand the versioned endpoints used by the authenticated Impact Gate website.Impact Gate MCP serverThe hosted MCP endpoint that gives AI coding assistants read-only, workspace-scoped API impact evidence, with OAuth sign-in and no API keys.MCP tools referenceParameters and examples for the six read-only tools exposed by the Impact Gate MCP server.Agent plugin review walkthroughA recorded end-to-end walkthrough of the Impact Gate agent plugin for marketplace reviewers: installation, OAuth authorization, MCP connection, read-only tools, tenant scoping, and representative output.Terms of ServiceThe terms that govern use of the Impact Gate website, workspace, GitHub App, and agent plugin.Reference
05
Detect downstream microservice impact before merging a GitHub PRA practical workflow for checking an OpenAPI diff, finding affected consumers, and reading the evidence and coverage notes on a GitHub pull request.How to find who consumes your API before you change itFind API consumers across repositories, troubleshoot missing matches, and understand what code and runtime evidence can and cannot prove.Retirement Radar checklist: evidence before removing an APIA step-by-step API deprecation checklist: discover consumers, publish a migration window, inspect runtime evidence, and record what remains unknown.Cross-repository API change impact analysisBuild a provider-to-consumer view across selected repositories, follow endpoint evidence, and coordinate changes with clear scope and coverage limits.oasdiff vs API consumer impact analysis: what each report tells youA grounded comparison of OpenAPI contract diffing and repository-level consumer impact analysis, including how to use both in a pull request review.Find API consumers with repository evidence and Prometheus or DatadogMatch Prometheus and Datadog observations to API routes, distinguish traffic from caller identity, and use runtime evidence alongside static consumer analysis.API backward compatibility: which changes actually break consumersA field-by-field reference for which REST API changes break existing consumers, which are usually safe, and how to check a change against real consumer code before merge.How to deprecate a repository: a checklistSteps to retire a GitHub repository without breaking dependents: find dependents, announce, redirect, archive.