agentleFS
mckinseymckinsey/agents-at-scale-ark/.claude/skills/ark-sdk-development/SKILL.md

ark-sdk-development

Skill438 starsChanged 7 months agoApache-2.0View on GitHub

Regenerate and debug types across the ARK stack (SDK, API, Dashboard). Use when fixing TypeScript type errors in ark-dashboard, updating types after CRD changes, regenerating types.ts from OpenAPI spec, debugging "Property does not exist on type" schema errors, or adding custom SDK functionality via overlays. Covers the full type pipeline from Kubernetes CRDs to TypeScript.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Add Python files to lib/ark-sdk/gen_sdk/overlay/python/ark_sdk/

    line 42
  2. Distinctive:

    When to update ark-api models:

    line 49
  3. Distinctive:

    When exposing new CRD fields via the HTTP API

    line 50
  4. Distinctive:

    When adding new API response types

    line 51
  5. Very specific:

    If you see schema names with __models__ pattern (e.g., ark_api__models__agents__Header-Input):

    line 99
  6. Very specific:

    Do NOT work around by using the __models__ name - fix the root cause

    line 102

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

ARK SDK and Type Development

Type Generation Pipeline

Types flow through the ARK stack:

CRD YAML (ark/config/crd/)
    ↓ make ark-sdk-build (automatic)
ark-sdk Python types + overlay utilities
    ↓
ark-api Pydantic models (manual updates if exposing new fields)
    ↓ make ark-api-build → generates openapi.json
ark-dashboard TypeScript types
    ↓ npm run generate:api → generates types.ts

ark-sdk: Automatic Type Generation

CRD types are automatically generated from Kubernetes CRD YAML files.

make ark-sdk-build

This runs:

  1. crd_to_openapi.py - converts CRDs to OpenAPI schema
  2. openapi-generator-cli - generates Python types from schema
  3. Copies overlay files on top of generated code
  4. Builds wheel package

Adding Custom SDK Functionality (Overlays)

The lib/ark-sdk/gen_sdk/overlay/python/ark_sdk/ directory contains custom Python modules that are copied on top of generated code. This is how utilities like client.py, k8s.py, and executor.py are added.

To add custom SDK functionality:

  1. Add Python files to lib/ark-sdk/gen_sdk/overlay/python/ark_sdk/
  2. Run make ark-sdk-build

ark-api: Manual Model Updates

The ark-api has manually written Pydantic models in services/ark-api/ark-api/src/ark_api/models/.

When to update ark-api models:

  • When exposing new CRD fields via the HTTP API
  • When adding new API response types
make ark-api-build

This generates services/ark-api/openapi.json from FastAPI routes and Pydantic models.

Pydantic Model Naming (CRITICAL)

Pydantic model class names MUST be globally unique across all model files. When multiple files define classes with the same name (e.g., ConfigMapKeyRef, Header, ValueFrom), FastAPI generates non-deterministic OpenAPI schema names like ark_api__models__agents__Header-Input. These names depend on import order and cause CI failures when types.ts differs between environments.

Solution: Prefix class names with their domain context:

FileNaming PatternExamples
agents.pyAgent*AgentHeader, AgentValueFrom, AgentParameter
mcp_servers.pyMCPServer*MCPServerHeader, MCPServerValueSource
queries.pyQuery*QueryParameter, QueryLabelSelector
models.pyModel*ModelValueSource

Safety net: generate_openapi.py fails if any schema name contains __models__, catching collisions at build time.

See: https://github.com/mckinsey/agents-at-scale-ark/issues/656

ark-dashboard: TypeScript Type Generation

cd services/ark-dashboard/ark-dashboard
cp ../../ark-api/openapi.json ../out/
npm run generate:api
npm run build  # verify types compile

Debugging Type Errors

When you see:

Property 'SomeSchema' does not exist on type
  1. Regenerate types.ts from latest openapi.json
  2. Find the correct schema name:
    grep "SomeSchema" services/ark-dashboard/ark-dashboard/lib/api/generated/types.ts
  3. Update service files to use correct schema names

If you see schema names with __models__ pattern (e.g., ark_api__models__agents__Header-Input):

  • This indicates a Pydantic model naming collision
  • Fix by renaming the Python class to be unique (see naming convention above)
  • Do NOT work around by using the __models__ name - fix the root cause

Key Files

FilePurpose
ark/config/crd/bases/*.yamlSource of truth - Kubernetes CRDs
lib/ark-sdk/gen_sdk/overlay/Custom SDK utilities (copied on top of generated)
services/ark-api/ark-api/src/ark_api/models/Manually written Pydantic models
services/ark-api/ark-api/generate_openapi.pyGenerates openapi.json with collision safety net
services/ark-api/openapi.jsonGenerated OpenAPI spec from FastAPI
services/ark-dashboard/out/openapi.jsonCopy used for dashboard type generation
services/ark-dashboard/ark-dashboard/lib/api/generated/types.tsGenerated TypeScript types

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.