docs(examples): jenkins-triage agent walkthrough (cictl integration)#2095
Open
Feelings0220 wants to merge 3 commits into
Open
docs(examples): jenkins-triage agent walkthrough (cictl integration)#2095Feelings0220 wants to merge 3 commits into
Feelings0220 wants to merge 3 commits into
Conversation
Adds examples/jenkins-triage/README.md, a worked example showing how to wire an external read-only CI inspection CLI (cictl, https://github.com/Feelings0220/cictl) into a kagent Agent for Jenkins build-failure triage. Documents the "external CLI + skill markdown + custom runtime image" pattern as a complement to the existing MCP-server-based pattern used by built-in agents like observability and istio. Includes inline YAMLs the user can copy-paste (Secret + Agent CRD), references a Dockerfile pattern in the cictl repo for the custom runtime image, and explicitly compares against an MCP-based alternative. One new file, no CRD changes, no Helm chart. Signed-off-by: Feelings0220 <124495386+Feelings0220@users.noreply.github.com>
github-actions
Bot
added
the
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new worked example documenting how to integrate an external, read-only Jenkins inspection CLI (cictl) into a kagent Declarative Agent by packaging the CLI into the agent runtime image, loading skill markdown from Git, and mounting credentials via a Secret.
Changes:
- Added an end-to-end walkthrough for a Jenkins triage agent that shells out to
cictlfor build/log/config inspection. - Documented a gitRefs-based skills workflow plus a custom runtime-image pattern and Secret-mounted credentials.
- Included a “why not MCP” comparison and a simple operational check for read-only behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+51
to
+54
| 1. **kagent installed** with `app.agentImage` either pointing at a custom image | ||
| that has `cictl` in `PATH`, or otherwise made available to the Agent's main | ||
| container. Build instructions: | ||
| [cictl/docs/runtime-setup.md](https://github.com/Feelings0220/cictl/blob/v0.1.0/docs/runtime-setup.md). |
Comment on lines
+101
to
+104
| gitRefs: | ||
| - url: https://github.com/Feelings0220/cictl | ||
| ref: v0.1.0 | ||
| path: skills |
Comment on lines
+111
to
+113
| You have access to the `cictl` CLI for querying Jenkins read-only. The | ||
| `jenkins` skill in /skills describes every available command and a | ||
| triage playbook. Follow it. |
| EOF | ||
| ``` | ||
|
|
||
| ## Step 2 — Apply the Agent CRD |
- Correct Helm key app.agentImage -> controller.agentImage - Set gitRefs name: cictl so the skill mounts at /skills/cictl, and point the systemMessage at /skills/cictl instead of /skills - Reword 'Apply the Agent CRD' -> 'Apply the Agent' (applies an Agent CR) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Feelings0220 <124495386+Feelings0220@users.noreply.github.com>
Feelings0220
force-pushed
the
feat/examples-jenkins-triage
branch
from
2bbf22f to
e316118
Compare
cictl now ships the skill as skills/jenkins/SKILL.md (the layout kagent's loader requires). Update the gitRefs example to path: skills/jenkins, name: jenkins, ref: v0.1.2, and fix the /skills path in the systemMessage. Also bump doc links to v0.1.2 and drop the link to a shared-library guide that is not in the repo. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Feelings0220 <124495386+Feelings0220@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
examples/jenkins-triage/README.md, a worked example showing how to wire an external read-only CI inspection CLI (cictl) into a kagent Agent for Jenkins build-failure triage.Why
kagent's existing built-in agents (k8s, istio, observability, …) all use MCP servers as tool providers. There is currently no documented path for the "I already have a CLI tool; how do I get my Agent to use it?" case. This example fills that gap with:
Agent.spec.skills.gitRefs(pointing at the cictl repo)docker/Dockerfile.runtime)Agent.spec.declarative.deployment.volumes/volumeMountsThe example explicitly compares its approach against an MCP-server-based alternative, so readers understand when to choose each.
cictl itself is compile-time read-only (its HTTP client exposes only
GET), so this triage agent cannot mutate Jenkins state regardless of LLM behavior.Scope
examples/jenkins-triage/README.mdTest plan
docs/runtime-setup.mdjenkins-cictl-credentialsSecretGETrequests during a triage session (read-only guarantee holds end-to-end)Related