Manifest (ingot.json)

Every extension has an ingot.json at its root: who publishes it, its version and type, what it adds to Ingot, and which files go into the .ingotx package. This page lists every field and the checks the store runs on it.

Add the schema line and your editor completes and checks the file as you type:

{ "$schema": "https://www.ingotide.com/schemas/ingot.json" }

Example

{
  "$schema": "https://www.ingotide.com/schemas/ingot.json",
  "name": "react-rules",
  "publisher": "acme",
  "displayName": "React Rules",
  "version": "1.2.0",
  "type": "rules",
  "description": "Conventions for React and TypeScript projects.",
  "license": "MIT",
  "repository": "https://github.com/acme/react-rules",
  "keywords": ["react", "typescript"],
  "icon": { "mark": "Re", "color": "#1B2647" },
  "engines": { "ingot": ">=0.1.0" },
  "contributes": {
    "rules": [{ "path": "rules/react.mdc" }],
    "commands": [{ "name": "review", "description": "Review the open files", "path": "commands/review.md" }]
  }
}

Fields

FieldRequiredRules
$schemanomust be https://www.ingotide.com/schemas/ingot.json when set
nameyes2 to 50 lowercase letters or digits, words joined with -; unique within your publisher
publisheryesyour publisher handle (3 to 32 characters)
displayNameyesthe store name, up to 60 characters
versionyessemantic version like 1.0.0 or 1.1.0-beta.1, no v
typeyestheme, rules, habits, mcp or rex-template (types)
descriptionyesone line for the store card, up to 200 characters
licenseyesan SPDX id such as MIT or Apache-2.0
repository, homepagenohttps:// URLs, shown on the store page
keywordsnoup to 10 words (30 characters each), used by store search
iconno{ "mark": "Re", "color": "#RRGGBB" }: 1 to 3 characters on a colored tile
enginesno{ "ingot": ">=0.1.0" }: the oldest Ingot it works with
filesnoup to 50 extra files or folders to package (scripts, assets, server code)
contributesyeswhat the extension adds; see below

The extension id is publisher.name (for example acme.react-rules); its store page is /marketplace/acme.react-rules. Unknown fields are rejected, and so are downloads, installs, rating, ratings, reviews and stars: the store doesn't show numbers it didn't measure.

contributes

KeyEntryFiles
themes{ "id", "label", "uiTheme": "dark" or "light", "path" }.json color theme with colors and/or tokenColors
rules{ "path" }.md or .mdc
habits{ "path" }.json with id, title, match, rule, optional threshold
commands{ "name", "description", "path" }.md; name becomes /name in agent chat
mcpServers"id": { "command", "args", "env" } or "id": { "url" }none (list server code under files)
rexTemplates{ "id", "title", "path" }.md

The contributes key that matches the type must have at least one entry. Ids and command names must be unique within the package.

For MCP servers: command is the program to run, args its arguments (${extensionDir} is replaced with the install folder), and env maps each UPPER_SNAKE_CASE variable name to a description of what the user should enter. A remote server has only url, which must be https://.

What goes in the package

ingot package includes:

  1. ingot.json
  2. README.md, CHANGELOG.md and LICENSE (or LICENSE.md, LICENSE.txt) when they exist
  3. every file a contributes entry points at
  4. everything listed in files (a folder includes everything inside it)

Nothing else is packaged, so node_modules, .git and local notes stay out. The store rejects a package that contains anything else.

Paths must be relative, use /, and stay inside the package: no .., no leading /, no hidden files or folders.

Limits

LimitValue
Package (.ingotx) size4 MB
Unpacked size20 MB
One file2 MB
Files in a package200
README shown on the store page50,000 characters
Uploads per publisher30 per hour

The .ingotx format

A .ingotx file is a standard ZIP archive with ingot.json at the root. You can open it with any unzip tool. The CLI writes entries in a fixed order with fixed timestamps, so packaging the same sources twice gives the same bytes and the same SHA-256. The store re-checks everything on upload: the manifest, every path, the file contents and the limits above.