Cursor Skill

ai-read-docs

Checks primary official docs for versioned/external behavior: packages, SDKs, APIs, CLIs, cloud services, current behavior, API drift, setup/config, or high-stakes auth, security, billing, data, migration, deployment, compliance, or privacy. Not general external research (/ai-res

LLM Mart · 0 points · 0 views 0 listing impressions 0 install-command copies
Download arcasilesgroup-ai-engineering-skills_ai-read-docs-46b6569.zip · 3 KB

Install

skills CLI npx skills add https://github.com/arcasilesgroup/ai-engineering/tree/main/skills/ai-read-docs
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install arcasilesgroup-ai-engineering@llmmart
Git git clone https://github.com/arcasilesgroup/ai-engineering.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole arcasilesgroup/ai-engineering collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

ai-read-docs — docs before memory

Do not guess where authoritative docs can answer the question. The most common right move is to web-search for the current official docs, open the relevant pages, and read them before coding. For APIs, versions, provider behavior, config, limits, lifecycle hooks, or security-sensitive flows, ground the answer in what the docs actually say. Prefer local docs, specs, schemas, generated types, and tests for internal contracts.

Docs-First Triggers

Read docs before proceeding when any of these are true:

  • The user asks for "latest", "current", "official", "supported", "best practice", "recommended", "today", "now", or "look it up".
  • The needed docs are not already in the repo or supplied by the user. Search the web for the official docs rather than hoping model memory is current.
  • The task adds, upgrades, configures, or imports a package, SDK, framework, plugin, CLI, model, cloud resource, or provider integration.
  • The API is fast-moving or version-sensitive: AI SDKs, OpenAI/Anthropic/Google APIs, Next.js, React, Tailwind, Vite, Nitro, Drizzle, Prisma, Stripe, GitHub, Slack, Notion, browser APIs, deployment platforms, auth libraries, and similar.
  • The implementation depends on auth, OAuth scopes, permissions, secrets, webhooks, billing, payments, PII, encryption, data retention, migrations, retries, rate limits, quotas, caching, deploys, or compliance.
  • An error mentions deprecation, unknown options, missing exports, invalid config, unsupported fields, changed defaults, or version mismatch.
  • A repo has local docs, ADRs, generated schemas, OpenAPI specs, route/action registries, design-system docs, or package-level READMEs that could define the contract.
  • The choice is expensive to reverse: public wire formats, database schema, migration strategy, persistent IDs, event names, customer-visible behavior, or external automation contracts.
  • You catch yourself about to write "usually", "probably", "I think", "from memory", or code copied from model memory for an external API.

What Counts As Docs

Use the most authoritative source available:

  • Local repo docs, specs, ADRs, schemas, generated types, package READMEs, and tests for project-specific behavior.
  • Official product docs, API references, migration guides, changelogs, release notes, and SDK source/types for third-party behavior. Find these with web search when you do not already have the exact URL.
  • Package registry metadata for versions. Before adding a dependency, run npm view <pkg> version, pnpm view <pkg> version, or the ecosystem equivalent, then read the docs for that major version.
  • Source code or type definitions when official docs are incomplete. Treat this as evidence, not folklore.

Avoid Stack Overflow, old blog posts, random snippets, and memory as the primary source when official docs exist. Use community sources only to debug symptoms after the authoritative contract is known.

Required Workflow

  1. Identify the exact surface: package name, installed version, target version, provider endpoint, CLI command, config file, local helper, schema, or product feature.
  2. Search the web for the current official docs unless the relevant docs are already local or the user supplied a URL. Use targeted searches such as <product> <feature> official docs, <package> migration guide, or <provider> API reference.
  3. Open and read the docs closest to that surface. Prefer local docs first for internal code, then official upstream docs. For new packages, verify the latest version before writing imports, config, or install commands.
  4. Extract the few facts needed for the task: option names, imports, lifecycle rules, default behavior, breaking changes, limits, permissions, and examples for the current major version.
  5. Implement or answer using those facts. If the docs conflict with existing code, inspect the local code path and call out the discrepancy.
  6. Verify with the smallest useful check: typecheck, tests, build, CLI dry run, API schema validation, or a local reproduction.
  7. In the final answer, name the docs or local files consulted when that evidence affects the recommendation or implementation.

Examples That Must Trigger Docs

  • "Add Tailwind to this app." Check the current Tailwind major and its install docs from the web before creating config files or assuming old PostCSS setup.
  • "Use the AI SDK to stream responses." Verify the current AI SDK major, imports, provider package names, streaming helpers, and server/runtime examples from official docs.
  • "Wire up Stripe webhooks." Read Stripe's current signature verification, event retry, endpoint secret, and framework body-parsing docs before coding.
  • "Fix this Next.js caching bug." Read the docs for the installed Next.js major and router mode before assuming cache invalidation semantics.
  • "Add Drizzle migrations." Read the current Drizzle kit docs and existing repo migration conventions before generating files.
  • "Create a GitHub Action." Read official Actions syntax and permissions docs, especially for pull_request, workflow_run, OIDC, tokens, and artifacts.
  • "Why does this OAuth flow fail?" Read the provider's scopes, redirect URI, PKCE, token refresh, and app verification docs before changing code.
  • "Use this repo's plan/comment/action system." Read local docs, route/action registries, schemas, and tests before inventing endpoints or props.
  • "Upgrade Vite/Nitro/React." Read the migration guide for the exact target major before editing config or imports.
  • "What model should we use?" Read current provider model docs, pricing/limits pages, and SDK examples before recommending.

When A Quick Local Read Is Enough

Do not browse the web for every tiny edit. A docs pass can be local and brief when the answer is already in the repo: existing helper usage, nearby tests, typed interfaces, generated clients, ADRs, or package READMEs. But if the task depends on an external tool, package, provider, or current product behavior, web search is usually the right first step. For trivial language syntax, typo fixes, formatting, or self-contained code with no external contract, proceed normally.

If Docs Are Unavailable

If network access, auth, or missing local files prevents reading the docs, say that plainly before relying on memory. Narrow the uncertainty, inspect source or types if available, and avoid presenting the result as confirmed-current.

The ai-engineering seam

  1. Name change only: this is BuilderIO's read-the-damn-docs method, kept intact under the official ai-engineering name. Docs reading is a duty in ai-brainstorm, ai-research, ai-architect and ai-orchestrator (blueprint §11.6), which cite this skill rather than re-stating its triggers.

Lifecycle

Lane: any Writes: nothing Read by: n/a Dies: n/a — the version it read lands in the artifact that cites it Next: none

Source: read-the-damn-docs by BuilderIO — https://github.com/BuilderIO/skills (Apache-2.0; agent-native.com).

Files (ai-engineering)
  • SKILL.md 7.3 KB
    ---
    name: ai-read-docs
    description: >-
      Checks primary official docs for versioned/external behavior: packages, SDKs, APIs, CLIs,
      cloud services, current behavior, API drift, setup/config, or high-stakes auth, security,
      billing, data, migration, deployment, compliance, or privacy. Not general external research
      (/ai-research) or questions the repo answers (/ai-explore).
    license: Apache-2.0
    ---
    
    # ai-read-docs — docs before memory
    
    Do not guess where authoritative docs can answer the question. The most common
    right move is to web-search for the current official docs, open the relevant
    pages, and read them before coding. For APIs, versions, provider behavior,
    config, limits, lifecycle hooks, or security-sensitive flows, ground the answer
    in what the docs actually say. Prefer local docs, specs, schemas, generated
    types, and tests for internal contracts.
    
    ## Docs-First Triggers
    
    Read docs before proceeding when any of these are true:
    
    - The user asks for "latest", "current", "official", "supported", "best
      practice", "recommended", "today", "now", or "look it up".
    - The needed docs are not already in the repo or supplied by the user. Search
      the web for the official docs rather than hoping model memory is current.
    - The task adds, upgrades, configures, or imports a package, SDK, framework,
      plugin, CLI, model, cloud resource, or provider integration.
    - The API is fast-moving or version-sensitive: AI SDKs, OpenAI/Anthropic/Google
      APIs, Next.js, React, Tailwind, Vite, Nitro, Drizzle, Prisma, Stripe, GitHub,
      Slack, Notion, browser APIs, deployment platforms, auth libraries, and similar.
    - The implementation depends on auth, OAuth scopes, permissions, secrets,
      webhooks, billing, payments, PII, encryption, data retention, migrations,
      retries, rate limits, quotas, caching, deploys, or compliance.
    - An error mentions deprecation, unknown options, missing exports, invalid
      config, unsupported fields, changed defaults, or version mismatch.
    - A repo has local docs, ADRs, generated schemas, OpenAPI specs, route/action
      registries, design-system docs, or package-level READMEs that could define the
      contract.
    - The choice is expensive to reverse: public wire formats, database schema,
      migration strategy, persistent IDs, event names, customer-visible behavior, or
      external automation contracts.
    - You catch yourself about to write "usually", "probably", "I think", "from
      memory", or code copied from model memory for an external API.
    
    ## What Counts As Docs
    
    Use the most authoritative source available:
    
    - Local repo docs, specs, ADRs, schemas, generated types, package READMEs, and
      tests for project-specific behavior.
    - Official product docs, API references, migration guides, changelogs, release
      notes, and SDK source/types for third-party behavior. Find these with web
      search when you do not already have the exact URL.
    - Package registry metadata for versions. Before adding a dependency, run
      `npm view <pkg> version`, `pnpm view <pkg> version`, or the ecosystem
      equivalent, then read the docs for that major version.
    - Source code or type definitions when official docs are incomplete. Treat this
      as evidence, not folklore.
    
    Avoid Stack Overflow, old blog posts, random snippets, and memory as the primary
    source when official docs exist. Use community sources only to debug symptoms
    after the authoritative contract is known.
    
    ## Required Workflow
    
    1. Identify the exact surface: package name, installed version, target version,
       provider endpoint, CLI command, config file, local helper, schema, or product
       feature.
    2. Search the web for the current official docs unless the relevant docs are
       already local or the user supplied a URL. Use targeted searches such as
       `<product> <feature> official docs`, `<package> migration guide`, or
       `<provider> API reference`.
    3. Open and read the docs closest to that surface. Prefer local docs first for
       internal code, then official upstream docs. For new packages, verify the
       latest version before writing imports, config, or install commands.
    4. Extract the few facts needed for the task: option names, imports, lifecycle
       rules, default behavior, breaking changes, limits, permissions, and examples
       for the current major version.
    5. Implement or answer using those facts. If the docs conflict with existing
       code, inspect the local code path and call out the discrepancy.
    6. Verify with the smallest useful check: typecheck, tests, build, CLI dry run,
       API schema validation, or a local reproduction.
    7. In the final answer, name the docs or local files consulted when that
       evidence affects the recommendation or implementation.
    
    ## Examples That Must Trigger Docs
    
    - "Add Tailwind to this app." Check the current Tailwind major and its install
      docs from the web before creating config files or assuming old PostCSS setup.
    - "Use the AI SDK to stream responses." Verify the current AI SDK major,
      imports, provider package names, streaming helpers, and server/runtime
      examples from official docs.
    - "Wire up Stripe webhooks." Read Stripe's current signature verification,
      event retry, endpoint secret, and framework body-parsing docs before coding.
    - "Fix this Next.js caching bug." Read the docs for the installed Next.js major
      and router mode before assuming cache invalidation semantics.
    - "Add Drizzle migrations." Read the current Drizzle kit docs and existing repo
      migration conventions before generating files.
    - "Create a GitHub Action." Read official Actions syntax and permissions docs,
      especially for `pull_request`, `workflow_run`, OIDC, tokens, and artifacts.
    - "Why does this OAuth flow fail?" Read the provider's scopes, redirect URI,
      PKCE, token refresh, and app verification docs before changing code.
    - "Use this repo's plan/comment/action system." Read local docs, route/action
      registries, schemas, and tests before inventing endpoints or props.
    - "Upgrade Vite/Nitro/React." Read the migration guide for the exact target
      major before editing config or imports.
    - "What model should we use?" Read current provider model docs, pricing/limits
      pages, and SDK examples before recommending.
    
    ## When A Quick Local Read Is Enough
    
    Do not browse the web for every tiny edit. A docs pass can be local and brief
    when the answer is already in the repo: existing helper usage, nearby tests,
    typed interfaces, generated clients, ADRs, or package READMEs. But if the task
    depends on an external tool, package, provider, or current product behavior, web
    search is usually the right first step. For trivial language syntax, typo fixes,
    formatting, or self-contained code with no external contract, proceed normally.
    
    ## If Docs Are Unavailable
    
    If network access, auth, or missing local files prevents reading the docs, say
    that plainly before relying on memory. Narrow the uncertainty, inspect source or
    types if available, and avoid presenting the result as confirmed-current.
    
    ## The ai-engineering seam
    
    1. Name change only: this is BuilderIO's read-the-damn-docs method, kept intact
       under the official ai-engineering name. Docs reading is a duty in
       ai-brainstorm, ai-research, ai-architect and ai-orchestrator (blueprint §11.6), which
       cite this skill rather than re-stating its triggers.
    
    ## Lifecycle
    
    Lane: any
    Writes: nothing
    Read by: n/a
    Dies: n/a — the version it read lands in the artifact that cites it
    Next: none
    
    Source: read-the-damn-docs by BuilderIO — https://github.com/BuilderIO/skills (Apache-2.0; agent-native.com).
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.