API doc summariser agent

Crawls internal API references and changelogs, then drafts integration guides and flags breaking changes for downstream engineering teams.

Engineering · Stack: Claude, Python, MCP, GitHub. Outcome: Integration ramp-up cut from days to hours

Overview

An agent that keeps integration guides current by reading the source API references and changelogs directly.

The problem

Internal API docs drift from the code, and engineers lose days reverse-engineering references and spotting breaking changes by hand.

How it works

• Crawls internal API references and changelogs straight from the repos.
• Extracts endpoints, parameters and version deltas into a structured model.
• Drafts a readable integration guide for each consumer team.
• Flags breaking changes and notifies the downstream teams that depend on them.

What it does

• Automated crawl of references and changelogs
• Auto-drafted integration guides per consumer
• Breaking-change detection with impact notes
• GitHub-native delivery via PRs and issues

Architecture

A Python agent on the Claude API, with MCP connectors into GitHub for source access and delivery.

Results

• Integration ramp-up cut from days to hours
• Docs that track the code instead of drifting
• Breaking changes caught before they reach consumers