docs(agenteye): document the agenteye-python-sdk agent skill#568
Conversation
Adds /agenteye/python-sdk-skill, completing the set: agenteye-cli has had a page since #561 and agenteye-evaluator since #567, but the skill that gets an agent emitting events in the first place had none — and it is the one the other two depend on. There is nothing to score and nothing to read until a session exists. The page leads with the silences rather than the API. The SDK's thirteen methods are easy to call and easy to get quietly wrong: no agent_start means every event lands and zero sessions appear; an unset environment files production runs under dev; outcome="failure" reads as success because only failed/error/timeout/rejected count; a typo'd field is accepted as a new field; events from a thread pool are dropped. None of them raise. So the page's weight sits on the skill's third step — verifying against the event files the SDK writes, which needs no server, no API key, and no network. Also fixes /agenteye/python-sdk, which told every reader to `pip install agenteye`. That name on public PyPI is the CLI — a different product sharing the distribution name — so the documented command installed the wrong thing and left `import agenteye` failing. The SDK is distributed privately, so the page now says that and points at onboarding rather than naming a command that cannot work. Cross-linked from cli-skill and evaluator-skill. English nav entry only; the daily translate-docs cron regenerates the 14 localized navs from the English tabs.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughAdds a Python SDK Agent Skill documentation page, updates private SDK installation guidance, registers the page in documentation navigation, and links it from the CLI and evaluator skill pages. ChangesPython SDK skill documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Automated code review started - full review. Results will be posted here. |
|
⏳ [progress] Review in progress — Phase 0-2 complete. Running build & MDX validation now... |
|
✅ Build & test complete. Results:
|
🔍 Automated Code Review📋 Executive SummaryThis PR adds the 📊 Change Architecturegraph TD
A["python-sdk.mdx (existing)"] -->|"fixed: removed wrong pip install, added verification command"| B["python-sdk-skill.mdx (NEW)"]
B -->|"cross-linked in"| C["cli-skill.mdx"]
B -->|"cross-linked in"| D["evaluator-skill.mdx"]
B -->|"nav entry added"| E["docs.json (en tab only)"]
F["CHANGELOG.md"] -->|"entry added"| B
style B fill:#90EE90
style A fill:#FFD700
style C fill:#87CEEB
style D fill:#87CEEB
style E fill:#87CEEB
style F fill:#87CEEB
Legend: 🟢 New | 🔵 Modified | 🟡 Bug Fix 🔴 Breaking Changes✅ No breaking changes detected. This is a docs-only PR. No code, schema, API, config, or dependency changes.
|
hermes-exosphere
left a comment
hermes-exosphere
left a comment
There was a problem hiding this comment.
Automated review: Approved. Docs-only PR — new skill page, bug fix for wrong install command, clean cross-linking. All 2174 tests pass, MDX validates, TypeScript clean. ✅
hermes-exosphere
left a comment
hermes-exosphere
left a comment
There was a problem hiding this comment.
Automated review: Approved. ✅
hermes-exosphere
left a comment
hermes-exosphere
left a comment
There was a problem hiding this comment.
Code Review Summary
Verdict: APPROVED ✅
PR: #568 — docs(agenteye): document the agenteye-python-sdk agent skill
Author: NiveditJain
Files changed: 6 (+142 -2)
🔴 Critical
None.
⚠️ Warnings
None.
💡 Suggestions
- docs/agenteye/python-sdk-skill.mdx:75-104 — The sample session transcript is excellent documentation, but the fixed-width text code block wraps at ~80 columns. On narrower viewports this may cause horizontal scroll. Consider a slightly narrower reflow for mobile readers — cosmetic, not blocking.
✅ Looks Good
-
The
pip install agenteyefix is the right fix. The old page told readers a command that installed the CLI (different product sharing the distribution name), makingimport agenteyefail. The new text states private distribution, gives a verification command, and points to the skill. It correctly does not name a private install command — that's enterprise-docs material. -
The new page's structure is exactly right. It leads with why the skill exists (the SDK's silent failures — the table of 5 mistakes that don't raise), not the API surface. The three-step plan→write→verify loop is clear and actionable. The sample session transcript demonstrates the skill's behavior concretely.
-
Cross-linking is thorough and directional. The skill relationship table correctly models the pipeline (SDK → Evaluator → CLI), and each sibling page links back with a purpose-specific description.
-
Nav placement is surgical. Added as a single line in
docs.jsonunder the English "SDK and CLI" group, immediately afterpython-sdk, matching the parent-then-skill pattern. No locale navs were touched — the translate-docs cron will regenerate those. -
No security concerns. No secrets, no internal paths, no private install commands. The only external link is to the public
FailproofAI/skillsGitHub repo. -
The CHANGELOG entry is correctly placed and references #568.
-
All referenced files exist. Every internal link resolves to an actual
.mdxfile on disk.
Reviewed by Hermes Agent
2 participants
Summary
Adds
/agenteye/python-sdk-skill, and fixes an install command on/agenteye/python-sdkthat has been telling readers to install the wrong product.agenteye-clihas had a page since #561 andagenteye-evaluatorsince #567. The third skill — the one that gets an agent emitting events in the first place — had none, which is the wrong one to be missing: there is nothing to evaluate and nothing to read back until a session exists, so this is where a new customer actually starts.What the page says, and why
The silences are the story, not the API. The SDK is thirteen keyword-only methods; an agent can read
/agenteye/python-sdkand produce plausible instrumentation in a minute. The reason a skill earns its place is that this SDK doesn't raise when you get it wrong, and wrong instrumentation is indistinguishable from right instrumentation until someone opens an empty dashboard:agent_startdev.outcome="failure"failed/error/timeout/rejectedcount.So the page's weight sits on the skill's third step — running the agent and reading the event files back. That step is the one people skip, and the SDK writes to local files, so a full integration can be proven with no server, no API key, and no network. That property is what makes the skill's promise checkable rather than aspirational.
pip install agenteyeinstalled the wrong product./agenteye/python-sdksaid "Install the SDK from PyPI:pip install agenteye". That name on public PyPI is the CLI — a separate product sharing the distribution name — so the documented command gave readers the CLI, andimport agenteyethen failed withModuleNotFoundError(the CLI's module isagenteye_cli). The SDK is distributed privately and is not on any public index.The page now states that distribution is private and points at onboarding, rather than naming a command that cannot work. It deliberately does not detail the private install mechanics — that is signed-customer material and lives in the enterprise docs. The skill page carries the same fact framed as a tell ("if your agent proposes installing from a public index, the skill didn't load"), which is the shape #567 used for the evaluator's unclaimed-name problem.
Changes
docs/agenteye/python-sdk-skill.mdxdocs/agenteye/python-sdk.mdxdocs/docs.jsonpython-sdkin SDK and CLI (same parent-then-skill placement #567 used)docs/agenteye/cli-skill.mdxdocs/agenteye/evaluator-skill.mdxCHANGELOG.mdDocsentry under0.0.14-beta.1 — 2026-07-17Translations
English nav only. The daily
translate-docscron walks the English.mdx, picks up the new source via the content-hash cache, and--update-navregenerates the 14 localized navs from the English tabs — so the locales fill in on the next run rather than needing 15 hand-written entries here.Worth noting explicitly: an earlier pass at
docs.jsonrewrote it withjson.dumps, which escaped every non-ASCII character and mangled all 14 locale nav labels (快速开始→快速...) — a 49-line diff hiding behind a one-line change. Reverted and inserted surgically; the diff here is exactly +1 line.Testing
bun run validate:mdx— 647 pages parse cleanly (646 before this page).agenteye/*.mdxis missing from the nav — the second direction is the onemintlify validatedoes not check, so an unregistered page would otherwise be green CI with no sidebar link.agenteye/python-sdk-skillwas added to theennav only, and no locale nav gained an entry (which would break validation for a page they don't have yet).mintlify@4.2.680 validatecould not be run locally: it refuses node 25+ and this machine is on 26. Leaving that to thedocsCI job — please don't merge on a red run. Everything it checks for this change (docs.json structure, nav-link resolution) is covered by the checks above, but it is the authority, not me.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation