docs(k8s-proxy): add Developer + LLM Workflow playbook (two-prompt autonomous flow)#862
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new v4.0.0 quickstart documentation page under the K8s Proxy section to describe a “Developer + LLM Workflow” using Keploy’s MCP server, and updates the versioned sidebar so the page is discoverable alongside the existing K8s proxy developer workflow.
Changes:
- Added a new doc page: Developer + LLM Workflow with Keploy Proxy (MCP setup + pasteable workflow playbook).
- Updated the v4.0.0 sidebar to include the new page under K8s Proxy.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| versioned_sidebars/version-4.0.0-sidebars.json | Adds the new LLM Workflow doc to the K8s Proxy sidebar group. |
| versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md | New documentation page covering MCP editor setup and a copy/paste playbook for a branch-first workflow. |
Comments suppressed due to low confidence (1)
versioned_docs/version-4.0.0/quickstart/k8s-proxy-llm-workflow.md:154
- The tool-surface table inside the playbook also uses
||at the start of each row. Since users are instructed to paste this block verbatim into their rules file, the malformed table will carry over. Switch it to normal Markdown table syntax (| ... |).
| Intent | Tool |
| -------------------------------------------- | ------------------------------------------------------------- |
| Add a hand-written mock to a test set | `create_mock` |
| Edit one mock's body / headers / spec | `update_mock` |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Copy everything between the fences—including the heading—into the file above. | ||
|
|
||
| ```markdown |
Comment on lines
+100
to
+104
| | Editor | Paste location | | ||
| | ------------------ | ----------------------------------------------------------------------------------------------------- | | ||
| | **Claude Code** | `CLAUDE.md` at your repo root (committed to git) **or** `~/.claude/CLAUDE.md` (personal, all repos). | | ||
| | **Cursor** | `.cursor/rules/keploy.md` in the repo (committed) **or** Cursor Settings → Rules for AI (global). | | ||
| | **Windsurf** | `.windsurfrules` at your repo root, or `~/.codeium/windsurf/memory/global_rules.md` (global). | |
|
|
||
| Pick your editor. Same JSON shape across all of them; only the config file path changes. | ||
|
|
||
| **Cursor**—`~/.cursor/mcp.json`: |
| } | ||
| } | ||
| ``` | ||
|
|
| # Developer + LLM Workflow with Keploy Proxy | ||
|
|
||
| import ProductTier from '@site/src/components/ProductTier'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; |
Comment on lines
+100
to
+106
| | Editor | Paste location | | ||
| | ------------------ | ----------------------------------------------------------------------------------------------------- | | ||
| | **Claude Code** | `CLAUDE.md` at your repo root (committed to git) **or** `~/.claude/CLAUDE.md` (personal, all repos). | | ||
| | **Cursor** | `.cursor/rules/keploy.md` in the repo (committed) **or** Cursor Settings → Rules for AI (global). | | ||
| | **Windsurf** | `.windsurfrules` at your repo root, or `~/.codeium/windsurf/memory/global_rules.md` (global). | | ||
| | **Claude Desktop** | A custom Project's "Project knowledge" section, or paste as the first message of each conversation. | | ||
| | **VS Code** | Workspace `.github/copilot-instructions.md` (Copilot Chat reads this) or paste in chat per session. | |
43a8964 to
ebeabd9
Compare
Sibling to the existing k8s-proxy-developer-workflow page. Documents
an autonomous Keploy workflow driven from an MCP-aware editor (Claude
Code, Cursor, Windsurf, Claude Desktop, VS Code Copilot, Trae). The
developer types one of two prompts; the agent does everything else.
The two prompts:
1. "my keploy cloud replay is failing, please analyse and fix it."
(or "the keploy cloud replay pipeline is failing..." for CI)
2. "Add new keploy tests for my changes."
The page ships a single pasteable playbook that installs as a Claude
Code skill or any other editor's rules / memory file. Inside the
playbook the agent:
- Resolves app_id from `basename $(pwd)` + listApps.
- Resolves branch_id from `git rev-parse --abbrev-ref HEAD` +
create_branch (find-or-create, idempotent, sticky for the session).
- Diagnoses failing runs via two cases: Case 1 (app regression, agent
fixes handler code and announces file:line before applying);
Case 2 (test data stale, with sub-actions 2a noise / 2a response
edit / 2b mock edit / 2b delete_recording + re-record).
- For new tests: git diff to find changed handlers, pre-flight the
dev's local run command, then `keploy record -c "<cmd>" --sync` +
`keploy upload test-set` to land the bundle on the branch.
Sidebar updated to surface the page under K8s Proxy.
Signed-off-by: Charan Kamarapu <kamarapucharan@gmail.com>
ebeabd9 to
244cd06
Compare
ayush3160
approved these changes
May 20, 2026
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.
Summary
Adds a sibling page to k8s-proxy-developer-workflow titled Developer + LLM Workflow with Keploy Proxy.
The page documents a workflow where the developer only ever types one of two prompts to their IDE agent (Claude Code / Cursor / Windsurf / Claude Desktop / VS Code / Trae):
Everything else — finding the app, resolving the Keploy branch, fetching the failing run, deciding whether the suite or the app code is at fault, applying the fix on the branch, re-running replay — is done autonomously by the agent. CI still owns the merge.
What's in the page
CLAUDE.md,.cursor/rules/keploy.md,.windsurfrules, etc.). Table of paste locations included.What's in the playbook (the pasteable block)
The directive embedded in the page covers:
branch_id); Keploy branch name mirrorsgit rev-parse --abbrev-ref HEAD; app resolved frombasename $(pwd); never edit app source as a workaround; never runkeploy cloud branch-mergefrom chat; never ask whatgit/files answer; always end with a dashboard URL.listApps,create_branch).test_suite_runvialistTestRuns.get_session_reportwithverbose=true.git log/git diff, not from dev questions:mock_mismatch_dominant=trueAND no relevant code changes → file as keploy egress-hook bug.update_mock/update_test_suiteon the branch (preserving step IDs), then re-runkeploy cloud replay --branch-name.git diff origin/main...HEADto enumerate added/modified HTTP endpoints.keploy recordwhile curling each new endpoint with dynamic values.keploy upload test-set --branch <git branch>.keploy cloud replay --branch-name. Fail → drop into Routine A.app_url). Everything else is autonomous.branch-merge, writing to main, re-recording without diagnosis.Why the page exists
The manual flow on the existing Developer Workflow page is still the source of truth for what each command does. This new page is the autonomous-LLM front-end on top of it: paste once, two-prompt operation from there on. CI YAML stays in YAML — agent does not touch CI.
Test plan
yarn start) and confirm the new page appears under K8s Proxy → LLM Workflow in the v4.0.0 sidebar.#wiring-up-your-ci-pipeline,#1-replay-on-pr-open) resolve.CLAUDE.md+ Cursor.cursor/rules/keploy.md) and confirm:git rev-parse --abbrev-ref HEAD+basename $(pwd).keploy cloud branch-mergefrom chat./client/v1/mcp).🤖 Generated with Claude Code