Skip to main content
Glama

axint.scaffold

Read-onlyIdempotent

Generate a TypeScript intent starter from a name and description. Returns a ready-to-save defineIntent() string with no file writes or network requests.

Instructions

Generate a starter TypeScript intent file from a name and description. Returns a complete defineIntent() source string ready to save as a .ts file — no files are written, no network requests made. On invalid domain values, returns an error string. The output compiles directly with axint.compile. Use: use to create a small TypeScript intent starter; use templates.get for richer examples and compile for Swift output. Inputs: name must be PascalCase; params define the starter contract; domain defaults to general. Effects: read-only generated TypeScript; writes no files and uses no network.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesPascalCase intent name, e.g., 'SendMessage' or 'CreateEvent'. Must start with an uppercase letter and contain no spaces.
domainNoApple App Intent domain.
paramsNoInitial parameters for the intent.
descriptionYesHuman-readable description of what the intent does, shown to users in Shortcuts and Spotlight, e.g., 'Send a message to a contact'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes
isErrorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • changedInput schema / properties / description / description
      Previous value: -"Human-readable description of what the intent does, shown to..."New value: +"Human-readable description of what the intent does, shown to users in Shortcuts and Spotlight, e.g., 'Send a message to a contact'."
    • changedInput schema / properties / domain / description
      Previous value: -"Apple App Intent..."New value: +"Apple App Intent domain."
    • changedInput schema / properties / name / description
      Previous value: -"PascalCase intent name, e.g., 'SendMessage' or..."New value: +"PascalCase intent name, e.g., 'SendMessage' or 'CreateEvent'. Must start with an uppercase letter and contain no spaces."
    • changedInput schema / properties / params / description
      Previous value: -"Initial parameter..."New value: +"Initial parameters for the intent."
    • addedInput schema / properties / params / items / description
      Added value: +"Parameter definition with name, type, and description."
    • addedInput schema / properties / params / items / properties / description / description
      Added value: +"Human-readable description shown in Shortcuts and Spotlight when users."
    • addedInput schema / properties / params / items / properties / name / description
      Added value: +"camelCase parameter name, e.g., 'recipient' or 'messageBody'."
    • addedInput schema / properties / params / items / properties / type / description
      Added value: +"Parameter type."
  2. Changed10 schema fields changedv0.4.34
    • changedInput schema / properties / description / description
      Previous value: -"Human-readable description of what the intent does, shown to users in Shortcuts and Spotlight, e.g., 'Send a..."New value: +"Human-readable description of what the intent does, shown to..."
    • changedInput schema / properties / domain / description
      Previous value: -"Apple App Intent domain. One of: messaging, productivity, health, social, finance, commerce, media,..."New value: +"Apple App Intent..."
    • changedInput schema / properties / name / description
      Previous value: -"PascalCase intent name, e.g., 'SendMessage' or 'CreateEvent'. Must start with an uppercase letter and..."New value: +"PascalCase intent name, e.g., 'SendMessage' or..."
    • changedInput schema / properties / params / description
      Previous value: -"Initial parameters for the intent. Each item needs name (camelCase), type (string | int | double | float |..."New value: +"Initial parameter..."
    • removedInput schema / properties / params / items / description
      Removed value: -"Parameter definition with name, type, and description"
    • removedInput schema / properties / params / items / properties / description / description
      Removed value: -"Human-readable description shown in Shortcuts and Spotlight when users..."
    • removedInput schema / properties / params / items / properties / name / description
      Removed value: -"camelCase parameter name, e.g., 'recipient' or 'messageBody'. Used as the..."
    • removedInput schema / properties / params / items / properties / type / description
      Removed value: -"Parameter type. One of: string, int, double, float, boolean, date, duration,..."
    • removedOutput schema / properties / isError / description
      Removed value: -"Whether Axint marked the tool response as an error."
    • removedOutput schema / properties / text / description
      Removed value: -"Primary Axint tool response text, matching the first text content block."
  3. Changed8 schema fields changedv0.4.28
    • changedInput schema / properties / description / description
      Previous value: -"Human-readable description of what the..."New value: +"Human-readable description of what the intent does, shown to users in Shortcuts and Spotlight, e.g., 'Send a..."
    • changedInput schema / properties / domain / description
      Previous value: -"Apple App Intent domain. One of: messaging,..."New value: +"Apple App Intent domain. One of: messaging, productivity, health, social, finance, commerce, media,..."
    • changedInput schema / properties / name / description
      Previous value: -"PascalCase intent name, e.g., 'SendMessage'..."New value: +"PascalCase intent name, e.g., 'SendMessage' or 'CreateEvent'. Must start with an uppercase letter and..."
    • changedInput schema / properties / params / description
      Previous value: -"Initial parameters for the intent. Each item..."New value: +"Initial parameters for the intent. Each item needs name (camelCase), type (string | int | double | float |..."
    • changedInput schema / properties / params / items / description
      Previous value: -"Parameter definition with name, type, and..."New value: +"Parameter definition with name, type, and description"
    • changedInput schema / properties / params / items / properties / description / description
      Previous value: -"Human-readable description shown in..."New value: +"Human-readable description shown in Shortcuts and Spotlight when users..."
    • changedInput schema / properties / params / items / properties / name / description
      Previous value: -"camelCase parameter name, e.g., 'recipient'..."New value: +"camelCase parameter name, e.g., 'recipient' or 'messageBody'. Used as the..."
    • changedInput schema / properties / params / items / properties / type / description
      Previous value: -"Parameter type. One of: string, int, double,..."New value: +"Parameter type. One of: string, int, double, float, boolean, date, duration,..."
  4. Addedv0.4.26

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds concrete behavioral context beyond these: no files are written, no network requests made, returns an error string on invalid domain, and output compiles directly with axint.compile. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (Use, Inputs, Effects) and front-loaded purpose. Minor repetition of 'writes no files and uses no network' appears twice, but overall it is efficient and scannable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema and 4 parameters, the description fully covers what the tool does, its return value, error behavior, and relationship to siblings. It also explains the compile integration with axint.compile, making it complete for an agent to select and invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds useful semantics: 'name must be PascalCase' (reinforces schema), 'params define the starter contract', and 'domain defaults to general' (not in schema). This adds value beyond the structured schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool generates a starter TypeScript intent file from a name and description, and that it returns a defineIntent() source string. It also explicitly distinguishes itself from siblings by recommending templates.get for richer examples and compile for Swift output.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit usage guidance: 'use to create a small TypeScript intent starter; use templates.get for richer examples and compile for Swift output.' This clearly tells the agent when to use this tool versus alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.