Skip to content

Commit a33f875

Browse files
arcappcircleclaude
andauthored
docs: split AI Insights into index page and Build Insights sub-page (#1254)
Convert docs/appcircle-ai/ai-insights.md into a category folder: index.md is a general AI Insights overview, and the Build Insights Report detail moves to a build-insights.md sub-page. Repoint the 'full metric reference' links in the Claude Assistant and MCP Server pages to the new sub-page. The /appcircle-ai/ai-insights URL is unchanged. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 6da6cc2 commit a33f875

5 files changed

Lines changed: 45 additions & 23 deletions

File tree

docs/appcircle-ai/ai-assistants/appcircle-claude-assistant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The plugin registers the [Appcircle MCP Server](/appcircle-ai/appcircle-mcp-serv
1616
| Skill | Purpose |
1717
|-------|---------|
1818
| `appcircle:doc-assistant` | Answers Appcircle questions using official sources (`docs.appcircle.io` and `appcircle.io`) |
19-
| `appcircle:build-insights-report` | Renders a visual Build Insights Report (health & trends, root cause, workflow quality, artifact health, queue time, and CI maturity) from the `get_build_insights_report` MCP tool. See [AI Insights](/appcircle-ai/ai-insights) for the full metric reference |
19+
| `appcircle:build-insights-report` | Renders a visual Build Insights Report (health & trends, root cause, workflow quality, artifact health, queue time, and CI maturity) from the `get_build_insights_report` MCP tool. See [Build Insights](/appcircle-ai/ai-insights/build-insights) for the full metric reference |
2020

2121
Claude Code and claude.ai install the plugin differently, so follow the steps for the surface you use. MCP tools are only available in Claude Code for now; installing the plugin in claude.ai gets you the `doc-assistant` skill, not the MCP tools.
2222

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "AI Insights",
3+
"position": 4,
4+
"collapsed": true,
5+
"collapsible": true
6+
}

docs/appcircle-ai/ai-insights.md renamed to docs/appcircle-ai/ai-insights/build-insights.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
---
2-
title: AI Insights
2+
title: Build Insights
33
description: Understand the Appcircle Build Insights Report - every section and metric returned by the get_build_insights_report MCP tool, and how to generate the visual report with the Appcircle Claude Assistant.
44
tags: [appcircle ai, ai insights, build insights]
5-
sidebar_position: 4
5+
sidebar_position: 1
66
---
77

88
import ContentRef from '@site/src/components/ContentRef';
99
import Screenshot from '@site/src/components/Screenshot';
1010

11-
# AI Insights
12-
13-
Turn your build history into answers. AI Insights reads your CI data and generates the Build Insights Report: trends, root causes, and a maturity score at a glance.
14-
15-
## Build Insights Report
11+
# Build Insights Report
1612

1713
The **Build Insights Report** gives you a snapshot of your CI health: build trends, failure root causes, workflow quality, artifact health, queue time, and an overall maturity score. Use the [Appcircle Claude Assistant](/appcircle-ai/ai-assistants/appcircle-claude-assistant) to get a visual report, or use the [Appcircle MCP client](/appcircle-ai/appcircle-mcp-server) directly.
1814

19-
### How to Generate a Report
15+
## How to Generate a Report
2016

2117
**With the Appcircle Claude Assistant**
2218

@@ -28,11 +24,11 @@ The **Build Insights Report** gives you a snapshot of your CI health: build tren
2824
- Call `get_build_insights_report` directly from any MCP-compatible client (Cursor, VS Code, Codex, and so on).
2925
- You get the same metrics as structured JSON, which you can read, feed into another tool, or visualize yourself.
3026

31-
### Report Sections
27+
## Report Sections
3228

3329
The report has six sections.
3430

35-
#### Maturity Assessment
31+
### Maturity Assessment
3632

3733
A single CI maturity score (0-100) for the period, with a label of **Developing**, **Practicing**, **Advancing**, or **Optimizing**, and the delta against the previous period. The overall score rolls up four weighted dimensions:
3834

@@ -53,7 +49,7 @@ Below the scores, a ranked **Top Improvements** list surfaces the highest-impact
5349

5450
<Screenshot url='https://cdn.appcircle.io/docs/assets/AI-110-Build-Insights-Maturity-Assessment.png'/>
5551

56-
#### Health Snapshot & Trends
52+
### Health Snapshot & Trends
5753

5854
**Health Snapshot** is a point-in-time view of the period:
5955

@@ -74,7 +70,7 @@ Below the scores, a ranked **Top Improvements** list surfaces the highest-impact
7470

7571
<Screenshot url='https://cdn.appcircle.io/docs/assets/AI-110-Build-Insights-Trends.png'/>
7672

77-
#### Root Cause
73+
### Root Cause
7874

7975
Failure analysis for the period:
8076

@@ -86,7 +82,7 @@ Failure analysis for the period:
8682

8783
<Screenshot url='https://cdn.appcircle.io/docs/assets/AI-110-Build-Insights-Root-Cause.png'/>
8884

89-
#### Workflow Quality
85+
### Workflow Quality
9086

9187
How well each profile's workflows match Appcircle's recommended flow:
9288

@@ -96,12 +92,12 @@ How well each profile's workflows match Appcircle's recommended flow:
9692

9793
<Screenshot url='https://cdn.appcircle.io/docs/assets/AI-110-Build-Insights-Trends-Workflow-Quality.png'/>
9894

99-
#### Artifact Health
95+
### Artifact Health
10096

10197
- Average primary artifact size per profile for the period, as a ranked bar chart.
10298
- Call-outs for the profile whose artifact grew the most and the one that shrank the most compared to the previous period (when a previous-period baseline exists).
10399

104-
#### Queue Time
100+
### Queue Time
105101

106102
How long builds waited before starting, tree-wide for the period:
107103

@@ -111,24 +107,24 @@ How long builds waited before starting, tree-wide for the period:
111107

112108
<Screenshot url='https://cdn.appcircle.io/docs/assets/AI-110-Build-Insights-Artifact-Queue.png'/>
113109

114-
### FAQ
110+
## FAQ
115111

116-
#### What's the Default Time Range?
112+
### What's the Default Time Range?
117113

118114
The last 30 days, compared against the 30 days before that for deltas. Pass `start_date` and `end_date` to the tool to use a different window; the tool compares it against a preceding period of the same length.
119115

120-
#### Can I Get This Report Outside the Appcircle Claude Assistant?
116+
### Can I Get This Report Outside the Appcircle Claude Assistant?
121117

122118
Yes, for the underlying data. Any MCP client can call `get_build_insights_report` and get the same metrics as JSON. The visual HTML report rendering shown on this page is produced by the `appcircle:build-insights-report` skill, which is currently exclusive to the [Appcircle Claude Assistant](/appcircle-ai/ai-assistants/appcircle-claude-assistant).
123119

124-
#### Why Is a Section Missing From My Report?
120+
### Why Is a Section Missing From My Report?
125121

126122
A section can be absent because there was not enough build activity to compute it for the requested period (for example, no builds, no queued builds, or no profiles with a comparable previous period), which is not an error and not a zero value. It can also be absent because your [access token](/appcircle-ai/appcircle-mcp-server#authentication) lacks the required permission for the data that section depends on. Generating the full report requires a token with at least the **Manager** role. Check your token's role permissions if a section you expect to see is consistently absent.
127123

128-
#### Does the Report Include Builds From Sub-Organizations?
124+
### Does the Report Include Builds From Sub-Organizations?
129125

130126
Only if you set `include_sub_orgs` to `true` when calling the tool. It defaults to `false`.
131127

132-
#### Why Might Workflow Quality Section Be Missing?
128+
### Why Might Workflow Quality Section Be Missing?
133129

134130
Workflow Quality is computed from profiles that have at least one Push or PR trigger configured. If no profiles in the organization have Push or PR triggers set up, the section is omitted from the report.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: AI Insights
3+
description: AI Insights turns your Appcircle build history into answers - trends, root causes, and a maturity score, generated from your CI data.
4+
tags: [appcircle ai, ai insights, build insights]
5+
sidebar_position: 4
6+
---
7+
8+
import ContentRef from '@site/src/components/ContentRef';
9+
10+
# AI Insights
11+
12+
Turn your build history into answers. AI Insights reads your Appcircle CI data and turns it into clear, actionable reports: trends, root causes, and a maturity score at a glance, without building dashboards yourself.
13+
14+
You generate these reports with the [Appcircle Claude Assistant](/appcircle-ai/ai-assistants/appcircle-claude-assistant) for a visual view, or through the [Appcircle MCP client](/appcircle-ai/appcircle-mcp-server) for the same data as structured JSON.
15+
16+
## [Build Insights Report](/appcircle-ai/ai-insights/build-insights)
17+
18+
The Build Insights Report gives you a snapshot of your CI health: build trends, failure root causes, workflow quality, artifact health, queue time, and an overall maturity score.
19+
20+
<ContentRef url="/appcircle-ai/ai-insights/build-insights">Build Insights Report</ContentRef>

docs/appcircle-ai/appcircle-mcp-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ You can exclude one or more toolsets when running the server (via environment va
9292
| Tool | Description | Permission |
9393
|------|-------------|------------|
9494
| `get_build_history_report` | Get build history report with pagination and optional filters (date range, build profile, organization). | Viewer |
95-
| `get_build_insights_report` | Get an aggregated Build Insights Report over build history: health snapshot and trends, root cause, artifact health, workflow quality, queue time, and maturity assessment. Defaults to the last 30 days; supports optional date range, section filtering, and sub-organization scope. See [AI Insights](/appcircle-ai/ai-insights) for the full metric reference. | Viewer |
95+
| `get_build_insights_report` | Get an aggregated Build Insights Report over build history: health snapshot and trends, root cause, artifact health, workflow quality, queue time, and maturity assessment. Defaults to the last 30 days; supports optional date range, section filtering, and sub-organization scope. See [Build Insights](/appcircle-ai/ai-insights/build-insights) for the full metric reference. | Viewer |
9696
| `get_signing_report` | Get signing report with pagination and optional filters (date range, organization, OS, build status). | Viewer |
9797
| `get_distribution_app_version_report` | Get daily usage report for distributed app versions with pagination and filters (date range, profile, OS, organization). | Viewer |
9898
| `get_distribution_sent_report` | Get daily usage report for distributed app sharing with pagination and filters (date range, profile, OS, organization). | Viewer |

0 commit comments

Comments
 (0)