New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Phoenix Typescript Package Docs

by Arize-ai in Arize-ai/phoenix

Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages.

Apache-2.0Auto-check passedAI & LLM Engineering

Install Phoenix Typescript Package Docs

skills CLI
$ npx skills add Arize-ai/phoenix --skill phoenix-typescript-package-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install Arize-ai/phoenix phoenix-typescript-package-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/Arize-ai/phoenix.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/phoenix-typescript-package-docs .claude/skills/phoenix-typescript-package-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
phoenix-typescript-package-docs
GitHub stars
12k
Token cost
~2.2k tokens
SKILL.md length
793 words
Files
1
Skills in repo
39
Repo updated
First seen
Licence
Apache-2.0

At a glance

Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages.

  • Works in 11 steps: Read code before editing docs → Document exported entrypoints, not… → Keep the packaged docs flat → …
  • Updating docs for @arizeai/phoenix-client
  • SKILL.md covers Quick Reference, Source Of Truth, Current Packaging Flow and Authoring Rules, plus 4 more sections
  • Calls node, npm and pnpm

What it does

Phoenix Typescript Package Docs is an agent skill from Arize-ai/phoenix. 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 nodemodules/.../docs content aligned with actual exports, or when modifying the sync and publish flow for packaged docs.

Its SKILL.md is about 2.2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in AI & LLM Engineering, covering LLM observability and LLM evaluation. It works with TypeScript, npm and OpenTelemetry. The repository describes itself as: AI Observability & Evaluation. The licence is Apache-2.0.

When your agent uses it

  • Updating docs for @arizeai/phoenix-client
  • @arizeai/phoenix-evals
  • @arizeai/phoenix-otel
  • Changing the Mintlify package-doc pages

Example prompts

  • “/phoenix-typescript-package-docs”

Workflow steps

11 steps, taken from the step headings in SKILL.md.

  1. Read code before editing docs
  2. Document exported entrypoints, not internals
  3. Keep the packaged docs flat
  4. Keep website docs and packaged docs aligned
  5. Prefer examples that prove real shapes
  6. Hide agent-only implementation context
  7. Determine the affected package and modules
  8. Update canonical Mintlify docs
  9. Sync generated package docs
  10. Verify the npm artifact
  11. Check for nav and path regressions

What it can do on your machine

Read from SKILL.md and the folder at commit 856100b. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • node
    • npm
    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use npm and pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Phoenix Typescript Package Docs loads about 2.2k tokens when it runs. Until then it costs about 108 tokens; SKILL.md has 793 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~108
When it runs · the whole SKILL.md, loaded when a task matches
~2.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Arize-ai/phoenix at commit 856100b, republished under its Apache-2.0 licence (© Arize-ai). 793 words, ~2,209 tokens.

Download SKILL.mdSave it as .claude/skills/phoenix-typescript-package-docs/SKILL.md (or your agent's skills folder).
name
phoenix-typescript-package-docs
description
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.
license
Apache-2.0
metadata.author
oss@arize.com
metadata.version
1.0.0
metadata.languages
TypeScript
metadata.internal
true

Phoenix TypeScript Package Docs

Keep the curated TypeScript package docs aligned with the real npm package surface area and with the publish-time sync flow.

Quick Reference

TaskWhat to inspectWhat to update
Fix a stale examplejs/packages/<pkg>/src/ exports and function signaturesCanonical MDX under docs/phoenix/sdk-api-reference/typescript/packages/<pkg>/
Add or remove a pageExisting package-doc folder and docs.json navCanonical MDX, docs.json, and any landing-page links
Add a new package to the bundled-docs systemjs/scripts/sync-package-docs.mjs and package package.jsonSync map, package files, package prepack, and Mintlify nav
Verify publish outputnode js/scripts/sync-package-docs.mjs and npm pack --dry-runGenerated js/packages/<pkg>/docs/ contents and tarball entries

Source Of Truth

The canonical authored docs live in Mintlify pages:

text
docs/phoenix/sdk-api-reference/typescript/packages/phoenix-client/
docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/
docs/phoenix/sdk-api-reference/typescript/packages/phoenix-otel/

The package examples remain in the package source trees:

text
js/packages/phoenix-client/examples/
js/packages/phoenix-evals/examples/
js/packages/phoenix-otel/examples/

The published npm docs are staged copies:

text
js/packages/phoenix-client/docs/
js/packages/phoenix-evals/docs/
js/packages/phoenix-otel/docs/

Do not hand-edit js/packages/*/docs/. Treat those folders as generated publish artifacts. Ground doc content in the real package src/ and examples/ directories, but keep the published package docs focused on curated MDX pages.

Current Packaging Flow

These files define the bundled-docs workflow:

  • js/scripts/sync-package-docs.mjs
  • js/packages/phoenix-client/package.json
  • js/packages/phoenix-evals/package.json
  • js/packages/phoenix-otel/package.json
  • docs.json
  • docs/phoenix/sdk-api-reference/typescript/overview.mdx
  • docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-client.mdx
  • docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-evals.mdx
  • docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-otel.mdx

Each supported package must have:

  • a canonical Mintlify package-doc folder
  • a docs entry in files
  • a prepack hook that runs the sync script for that package
  • a postpublish hook that removes staged package docs (not postpack — pnpm publish stats the package files after the pack lifecycle, so a postpack clean deletes them mid-publish and fails with ENOENT)
  • visible navigation in docs.json

Authoring Rules

1. Read code before editing docs

Always ground docs in the actual exported surface:

  • root exports: js/packages/<pkg>/src/index.ts
  • submodule exports: js/packages/<pkg>/src/<module>/index.ts
  • implementation and parameter shapes: matching files in src/**
  • real usage patterns: js/packages/<pkg>/examples/**

Do not infer argument names or object shapes from older docs. Confirm them from code first.

2. Document exported entrypoints, not internals

Prefer pages and examples that match package entrypoints a developer imports:

  • @arizeai/phoenix-client
  • @arizeai/phoenix-client/prompts
  • @arizeai/phoenix-client/spans
  • @arizeai/phoenix-client/sessions
  • @arizeai/phoenix-client/experiments
  • @arizeai/phoenix-evals
  • @arizeai/phoenix-evals/llm
  • @arizeai/phoenix-otel

Do not center docs around private helpers or internal-only module paths.

3. Keep the packaged docs flat

Inside each package docs/ folder, prefer a flat page layout such as:

text
overview.mdx
experiments.mdx

Top-level authored MDX pages should stay flat.

4. Keep website docs and packaged docs aligned

If you add, remove, or rename a package-doc page:

  1. update the canonical MDX file
  2. update docs.json
  3. update any package landing page links that point into the package-doc section
  4. rerun the sync script
5. Prefer examples that prove real shapes

When a function takes a wrapped object such as spanAnnotation, documentAnnotation, sessionAnnotation, spanNote, project, or dataset, the example must use the real wrapper shape from code.

Common failure mode: docs drift toward simplified pseudo-APIs that do not match actual exported parameter names.

Show full SKILL.md (350 more words)Show less
6. Hide agent-only implementation context

When a page benefits from implementation breadcrumbs like internal src/** paths or a full source map, do not render them as visible Markdown headings, bullet lists, or fenced code blocks in Mintlify.

Use hidden semantic HTML instead:

mdx
<section
  className="hidden"
  data-agent-context="relevant-source-files"
  aria-label="Relevant source files"
>
  <h2>Relevant Source Files</h2>
  <ul>
    <li><code>src/example.ts</code> for the canonical implementation</li>
  </ul>
</section>

<section
  className="hidden"
  data-agent-context="source-map"
  aria-label="Source map"
>
  <h2>Source Map</h2>
  <ul>
    <li><code>src/index.ts</code></li>
    <li><code>src/helpers.ts</code></li>
  </ul>
</section>

Use semantic HTML elements like <section>, <h2>, <ul>, and <li> inside these hidden blocks rather than generic <div> wrappers, Markdown bullets, or fenced text blocks. Reserve this pattern for brief agent-only implementation context. Keep user-facing docs focused on API behavior, workflows, and runnable examples. Do not treat hidden blocks as access control. If content should be hidden from navigation as a whole, use a hidden page instead.

Workflow

Step 1: Determine the affected package and modules

Inspect the code change or user request and map it to one or more packages:

  • phoenix-client
  • phoenix-evals
  • phoenix-otel

Then inspect the corresponding src/ exports before writing docs.

Step 2: Update canonical Mintlify docs

Edit only the canonical pages:

text
docs/phoenix/sdk-api-reference/typescript/packages/<pkg>/*.mdx

If the change affects high-level discovery, also update:

  • docs/phoenix/sdk-api-reference/typescript/overview.mdx
  • docs/phoenix/sdk-api-reference/typescript/arizeai-phoenix-<pkg>.mdx
Step 3: Sync generated package docs

Run:

bash
node js/scripts/sync-package-docs.mjs

Or for one package:

bash
node js/scripts/sync-package-docs.mjs phoenix-client
node js/scripts/sync-package-docs.mjs phoenix-evals
node js/scripts/sync-package-docs.mjs phoenix-otel

This stages:

  • canonical MDX pages into js/packages/<pkg>/docs/

To remove staged docs manually:

bash
node js/scripts/sync-package-docs.mjs clean phoenix-client
Step 4: Verify the npm artifact

From each affected package:

bash
cd js/packages/phoenix-client && npm pack --dry-run
cd js/packages/phoenix-evals && npm pack --dry-run
cd js/packages/phoenix-otel && npm pack --dry-run

Confirm the tarball includes:

  • docs/*.mdx
  • src/**
Step 5: Check for nav and path regressions

If you changed page names or package coverage:

  • confirm docs.json still parses
  • confirm every referenced package-doc page exists
  • confirm the package landing pages link to the correct section

When Adding A New Bundled-Docs Package

If Phoenix starts shipping package docs for another TypeScript package, update all of:

  1. docs/phoenix/sdk-api-reference/typescript/packages/<new-package>/
  2. docs.json
  3. js/scripts/sync-package-docs.mjs
  4. js/packages/<new-package>/package.json

Required package manifest changes:

  • include docs in files
  • add a prepack hook that syncs the package docs

Validation Checklist

  • Examples match actual exported argument shapes
  • Canonical docs were edited instead of generated package docs
  • node js/scripts/sync-package-docs.mjs succeeds
  • npm pack --dry-run includes docs/*.mdx
  • docs.json paths still resolve

Anti-Patterns

  • Editing js/packages/*/docs/ directly
  • Updating examples without checking src/**
  • Documenting internal helpers instead of importable entrypoints
  • Adding a package-doc page without wiring it into docs.json
  • Updating Mintlify docs but forgetting to verify the packed npm artifact

© Arize-ai, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/phoenix-typescript-package-docs of Arize-ai/phoenix.

Open the folder on GitHubat commit 856100b

Compare with similar skills

Phoenix Typescript Package Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Phoenix Typescript Package Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Phoenix Typescript Package Docs this skillArize-ai/phoenix12k—~2.2kAutomated safety check: PassApache-2.0
Failproof AI SDK IntegrationFailproofAI/failproofai5.3k—~6kAutomated safety check: PassCustom licence
Phoenix LLM ObservabilityOrchestra-Research/AI-Research-SKILLs13k2 repos~2.9kAutomated safety check: PassMIT
Phoenix Evalsgithub/awesome-copilot40k3 repos~1.1kAutomated safety check: PassApache-2.0
Otel JSollygarden/opentelemetry-agent-skills106—~655Automated safety check: PassApache-2.0
OmniRoute Cost and Usage CLIdiegosouzapw/OmniRoute74k1 repos~693Automated safety check: PassMIT

Similar skills

  • Failproof AI SDK Integration

    FailproofAI/failproofai

    Helps instrument a custom Python or TypeScript agent to record events for Failproof AI, verify what gets written, and run an evaluator worker that scores the runs.

    5.3k GitHub stars~6k tokensUpdated yesterday
    AI & LLM EngineeringAuto-check passed

  • Phoenix LLM Observability

    Orchestra-Research/AI-Research-SKILLs

    Sets up Arize Phoenix to trace, evaluate and monitor LLM applications, with instrumentation for OpenAI, LangChain and LlamaIndex and a self-hosted server.

    13k GitHub starsUsed in 2 repos~2.9k tokens
    AI & LLM EngineeringAuto-check passed

  • Phoenix Evals

    github/awesome-copilot

    Official

    Build and run evaluators for AI/LLM applications using Phoenix.

    40k GitHub starsUsed in 3 repos~1.1k tokens
    AI & LLM EngineeringAuto-check passed

  • Otel JS

    ollygarden/opentelemetry-agent-skills

    OpenTelemetry in Node.js / JavaScript / TypeScript — NodeSDK, declarative YAML configuration, auto-instrumentations, ESM vs CJS import patterns.

    106 GitHub stars~655 tokensUpdated yesterday
    DevOps & CloudAuto-check passed

  • OmniRoute Cost and Usage CLI

    diegosouzapw/OmniRoute

    View cost breakdowns, token usage, and call logs from the CLI. Filter by provider, model, or date range. Export usage reports and inspect per-connection…

    74k GitHub starsUsed in 1 repo~693 tokens
    AI & LLM EngineeringAuto-check passed

  • Duel Agents

    2aronS/Duel-Agents

    Use Duel Agents model routing in Cursor. An agent skill from 2aronS/Duel-Agents.

    745 GitHub stars~228 tokensUpdated 3 mo ago
    AI & LLM EngineeringAuto-check passed

More from Arize-ai/phoenix

All 39 skills in this repo

  • Harbor Exec

    Arize-ai/phoenix

    A skill your agent uses when working with Harbor's harbor exec CLI workflow: compiling files, directories, or globs into Harbor tasks; running map jobs; configuring artifacts and existence-only…

    12k GitHub stars~909 tokensUpdated today
    Auto-check passed

  • Mintlify

    Arize-ai/phoenix

    Build and maintain documentation sites with Mintlify. An agent skill from Arize-ai/phoenix.

    12k GitHub starsUsed in 8 repos~3.4k tokens
    Auto-check passed

  • Phoenix Frontend

    Arize-ai/phoenix

    Frontend development guidelines for the Phoenix AI observability platform.

    12k GitHub stars~709 tokensUpdated today
    Auto-check passed

  • Phoenix Graphql

    Arize-ai/phoenix

    Write efficient GraphQL queries against the Phoenix API. An agent skill from Arize-ai/phoenix.

    12k GitHub stars~2.2k tokensUpdated today
    Auto-check passed

  • Phoenix Server

    Arize-ai/phoenix

    Backend development guide for the Phoenix AI observability platform (Strawberry GraphQL, SQLAlchemy async, FastAPI).

    12k GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Phoenix Storybook

    Arize-ai/phoenix

    Conventions for creating, modifying, and reviewing production-faithful Storybook stories in the Phoenix frontend (js/app/stories, js/app/.storybook).

    12k GitHub stars~1.9k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Phoenix Typescript Package Docs

What does Phoenix Typescript Package Docs do?

Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages. Phoenix Typescript Package Docs is an agent skill from Arize-ai/phoenix. Maintain the bundled TypeScript package docs that ship inside Phoenix npm packages.

When should I use Phoenix Typescript Package Docs?

Phoenix Typescript Package Docs fits situations like: updating docs for @arizeai/phoenix-client; @arizeai/phoenix-evals; @arizeai/phoenix-otel; changing the Mintlify package-doc pages.

How do I install Phoenix Typescript Package Docs in Claude Code?

Run `npx skills add Arize-ai/phoenix --skill phoenix-typescript-package-docs -a claude-code`. Or copy the skill folder (.agents/skills/phoenix-typescript-package-docs in Arize-ai/phoenix) into .claude/skills/phoenix-typescript-package-docs in your project. Claude Code loads it when a task matches its description.

How do I install Phoenix Typescript Package Docs in Codex?

Run `npx skills add Arize-ai/phoenix --skill phoenix-typescript-package-docs -a codex`. Or copy the skill folder (.agents/skills/phoenix-typescript-package-docs in Arize-ai/phoenix) into .agents/skills/phoenix-typescript-package-docs in your project. Codex loads it when a task matches its description.

Can I use Phoenix Typescript Package Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Arize-ai/phoenix --skill phoenix-typescript-package-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/phoenix-typescript-package-docs, .gemini/skills/phoenix-typescript-package-docs, .github/skills/phoenix-typescript-package-docs and .opencode/skills/phoenix-typescript-package-docs in your project.

What does Phoenix Typescript Package Docs need to run?

Going by SKILL.md and its folder, Phoenix Typescript Package Docs needs the command-line tools its instructions call (node, npm and pnpm).

Does Phoenix Typescript Package Docs access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Phoenix Typescript Package Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Phoenix Typescript Package Docs use?

Phoenix Typescript Package Docs is published under the Apache-2.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Phoenix Typescript Package Docs use?

About 2.2k tokens (SKILL.md is roughly 8.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Phoenix Typescript Package Docs?

Skills that share tags, products or a category with Phoenix Typescript Package Docs: Failproof AI SDK Integration (FailproofAI/failproofai, 5.3k stars), Phoenix LLM Observability (Orchestra-Research/AI-Research-SKILLs, 13k stars), Phoenix Evals (github/awesome-copilot, 40k stars) and Otel JS (ollygarden/opentelemetry-agent-skills, 106 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Phoenix Typescript Package Docs?

Arize-ai (a GitHub organization) maintains it in Arize-ai/phoenix, which has 11,744 GitHub stars. The repository holds 39 skills in this directory. The repository was last updated on October 8, 2026.

Source: Arize-ai/phoenix on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.