mcpField
A
arktype-validation

arktype-validation

github.com/oakossDevelopment20143 installsUpdated 10w ago
Repository

About arktype-validation

arktype-validation is a skill for using ArkType in TypeScript projects, covering schema definitions, runtime validation, and type inference. It includes guidance on string-based expressions, transformations, scopes, and environment validation.

Key features

  1. 01Define schemas with string expressions
  2. 02Runtime validation and type inference
  3. 03Transformations, constraints, and custom validation
  4. 04Scopes, generics, and pattern matching
  5. 05Validate environment variables and Vite builds

Use cases

  1. 01Validate API request and response data
  2. 02Parse and validate JSON strings
  3. 03Validate form input and environment variables

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/oakoss/agent-skills --skill arktype-validation

After installing, type/arktype-validationin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
common-patterns.md
morphs-and-scopes.md
schema-types.md

Details

From the project README

ArkType Validation

Overview

ArkType is a TypeScript-native runtime validation library that defines schemas using string expressions mirroring TypeScript syntax, providing editor autocomplete, syntax highlighting, and optimized validators. Use when building type-safe APIs, validating JSON payloads, or replacing Zod with a more TypeScript-idiomatic approach. Not suitable for projects that need Zod ecosystem compatibility or JSON Schema output.

Package: arktype

Quick Reference

PatternUsage
type({ key: "string" })Define object schema
type("string")Primitive type
"string.email", "string.url"Built-in string validators
"string.trim", "string.lower"Built-in string morphs (transforms)
"string.json.parse"Parse JSON string to validated object
"number > 0", "string >= 1"Inline constraints
"string | number"Union types
"'a' | 'b' | 'c'"String literal unions
"string[]"Array types
"key?": "string"Optional properties
"key = 'default'"Default values
.pipe(), .to()Transform output (morphs)
.narrow()Custom validation (like Zod refine)
.pick(), .omit()Object property selection
.merge()Combine object types
scope({...}).export()Named type scopes with cross-references
type("<t>", { box: "t" })Generic type definitions
type.errorsError handling (check instanceof type.errors)
.assert(data)Throws on invalid input instead of returning
"(number % 2)#even"Branding — type-only validated marker
"0 <= number <= 100"Compact range constraints
configure()Global defaults (from arktype/config)
match()Type-safe pattern matching (2.1)
"+" : "reject"Inline undeclared key handling
arkenv({ PORT: "number" })Typesafe env var validation (ArkEnv)
arkenvVitePlugin(Env)Build-time env validation for Vite

Common Mistakes

MistakeFix
type("string.email()") with parenstype("string.email") (no parens)
Checking errors with === nullUse instanceof type.errors
{ key: "string?" } for optional{ "key?": "string" } (question mark on key)
Importing from arktype/typesImport type and scope from "arktype"
Nested type() in string expressionsUse scope() for cross-referencing types
Raw .pipe() without error handlingUse .pipe.try() for operations that can throw
"string.lowercase" for case morph"string.lower" (also "string.upper")
Configuring after importing arktypeImport arktype/config before arktype
Manual process.env parsingUse arkenv() for auto-coercion and validation

Delegation

Use this skill for ArkType schema definitions, runtime validation, morphs/transforms, scopes, and type inference. For Zod-based validation, delegate to the zod-validation skill.

References

  • Schema Types — primitives, string keywords, number constraints, objects, arrays, tuples, unions, optional, defaults
  • Morphs and Scopes — pipe, morph transforms, narrow validation, scopes, recursive types, generics, global configuration, pattern matching
  • Common Patterns — JSON parsing, form validation, API responses, error handling, ArkEnv environment variables, Vite plugin, comparison with Zod

Comments

Markdown supported