Vielzeug

Appearance

Package Metadata ​

Problem ​

You need structured metadata for a specific package — its exports, related packages, available doc pages, and category — to guide further tool calls or code generation.

Solution ​

Call get-package with packageSlug to get a single PackageMeta object for that package.

json
{ "name": "get-package", "arguments": { "packageSlug": "courier" } }

Result:

json
{
  "name": "@vielzeug/courier",
  "slug": "courier",
  "version": "3.0.1",
  "description": "Unified HTTP client with explicit cache keys, direct mutations, and streams",
  "category": "http",
  "keywords": ["http", "fetch", "cache", "mutation"],
  "exports": ["createCourier", "CourierError", "withBearerAuth"],
  "related": ["flux", "ripple", "spell"],
  "availableDocPages": ["index", "api", "usage", "examples"],
  "exampleIds": ["create-courier"],
  "hasSource": true
}

PackageMeta never includes full docs content, apiSource, example code, or typeSignatures. Use get-docs, get-source, get-example, and get-type-signature to retrieve those.

Pitfalls ​

  • PackageMeta strips docs, apiSource, examples, and typeSignatures from the full package record (reducing examples to exampleIds). It is a summary, not the complete data.
  • related contains slugs, not package names. Use them directly as packageSlug in subsequent get-package or get-docs calls.
  • hasSource: false means no src/index.ts was bundled for this package; get-source and get-type-signature will return isError: true for it.
  • An unknown packageSlug returns isError: true with available slugs listed — not an empty object.