CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

phoenix-typescript-package-docs

Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages. Use this skill whenever adding or updating docs for `@arizeai/phoenix-client`, `@arizeai/phoenix-evals`, or `@arizeai/phoenix-otel`, when changing the Mintlify package-doc pages, when keeping `node_modules/.../docs` content aligned with actual exports, or when modifying the sync and publish flow for packaged docs.

71

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

88%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A high-quality, project-grounded skill body: concrete commands, exact paths, an explicit multi-step workflow with verification steps, and a validation checklist. Its only weaknesses are mild redundancy (duplicated hidden-section examples, anti-patterns echoing authoring rules) and one long inlined pattern that could be split into a reference file.

Suggestions

Collapse the two hidden-<section> MDX example blocks into a single example to save ~15 lines without losing the pattern.

Give Step 5 an explicit verification command for docs.json (e.g., a parse/validate one-liner) and a short 'if it fails, fix and re-run sync' recovery note to close the feedback loop.

Consider moving the hidden-HTML authoring pattern (Authoring Rule 6) into a references/ file, keeping a one-line pointer in SKILL.md.

DimensionReasoningScore

Conciseness

Nearly everything is project-specific (paths, hooks, sync commands) and assumes Claude's competence; no known concepts are explained. Minor trimmable spots: two full hidden-<section> example blocks where one would suffice, and the Anti-Patterns list partially repeats the Authoring Rules. Not 5 because of that mild redundancy; not 3 because there is no real padding.

4 / 5

Actionability

Copy-paste-ready commands throughout: `node js/scripts/sync-package-docs.mjs` (all and per-package variants), the clean command, `cd js/packages/<pkg> && npm pack --dry-run`, plus exact canonical paths and the importable-entrypoint list. The common cases are fully covered; only Step 5's 'confirm `docs.json` still parses' lacks an explicit command.

5 / 5

Workflow Clarity

A clearly sequenced 5-step workflow with explicit validation steps (Step 4 verifies the packed artifact, Step 5 checks nav/path regressions) and a final Validation Checklist, plus verified nuance on the destructive postpublish-vs-postpack behavior. Not 4 because every checkpoint is explicit, including for the publish-time deletion of staged docs.

5 / 5

Progressive Disclosure

Well-organized single-file structure with a useful Quick Reference table and clear sections; no bundle files exist, and the skill is self-contained. Not 5 because at 270+ lines (beyond the simple-skill exception) roughly 35 lines of the hidden-HTML MDX pattern are inlined and would sit better in a reference file.

4 / 5

Total

18

/

20

Passed

Description

87%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: third-person, concrete, with an explicit multi-trigger 'Use when' clause and a well-delineated niche. The only slack is that the 'what' sentence carries one generic verb while the specific actions live in the trigger clause.

DimensionReasoningScore

Specificity

The 'what' is a single umbrella verb ('Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages'), but the trigger clauses enumerate several concrete actions ('adding or updating docs', 'changing the Mintlify package-doc pages', 'keeping `node_modules/.../docs` content aligned with actual exports', 'modifying the sync and publish flow'). Not 5 because the headline action is generic and coverage of maintenance activities (e.g., verification) is carried entirely by the when-clause; not 3 because multiple specific actions are explicitly listed.

4 / 5

Completeness

Clearly answers what ('Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages') and when, via an explicit 'Use this skill whenever...' clause with five concrete trigger phrases. Matches the top anchor exactly.

5 / 5

Trigger Term Quality

Good natural keyword coverage: 'TypeScript package docs', 'npm packages', 'Mintlify', 'node_modules', 'sync and publish flow', plus the three concrete package names. A few natural terms a user might say are missing (e.g., '.mdx', 'docs.json', 'API reference').

4 / 5

Distinctiveness Conflict Risk

A clear niche anchored by named scoped packages, Mintlify pages, and the npm packaging flow; a user mentioning these triggers is unambiguously asking for this skill, so conflict risk with other docs skills is minimal.

5 / 5

Total

18

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_field

'metadata' should map string keys to string values

Warning

Total

15

/

16

Passed

Repository

Arize-ai/phoenix

Path

.agents/skills/phoenix-typescript-package-docs/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.