chadtmiller.com/hud
A remote MCP server that shows atproto records as interactive UI inside MCP Apps hosts
place.hud.hudkit 0.3.1 Latest 5 packages
0
0
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://knotless.dev/chadtmiller.com/hud/raw/main/schemas/json/app.json",
"title": "A HUD app file (<domain>.json)",
"description": "An app served by HUD (HUD_APPS): its tabs and routes, each a tool call, and what its clients draw around them.",
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"hud": {
"type": "string",
"description": "The HUD versions the app runs on, a semver requirement, as >=0.2.0. A HUD older than it needs refuses the app."
},
"kits": {
"type": "object",
"properties": {
"oldest": {
"type": "string",
"description": "The oldest kit, the HUD version of the renderer an app's build in people's hands was made with, its clients still serve, as 0.2.0: hud check warns where a view uses a component or prop newer than it with no kit gate or fallback around it."
}
},
"additionalProperties": false,
"required": [
"oldest"
]
},
"domain": {
"type": "string",
"description": "The app's domain, as its file is named."
},
"name": {
"type": "string",
"minLength": 1
},
"tabs": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"call": {
"description": "A tool call that draws what a view draws: query (args method, params), describe_app (domain), get_record (uri) or list_records (collection).",
"type": "object",
"properties": {
"name": {
"enum": [
"query",
"describe_app",
"get_record",
"list_records"
]
},
"args": {
"type": "object"
}
},
"required": [
"name"
]
},
"guest": {
"anyOf": [
{
"const": "call"
},
{
"description": "A tool call that draws what a view draws: query (args method, params), describe_app (domain), get_record (uri) or list_records (collection).",
"type": "object",
"properties": {
"name": {
"enum": [
"query",
"describe_app",
"get_record",
"list_records"
]
},
"args": {
"type": "object"
}
},
"required": [
"name"
]
}
]
},
"first": {
"$ref": "#/$defs/place.hud.tabFirst.main"
}
},
"required": [
"label",
"call"
]
}
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"pattern": "^/"
},
"call": {
"description": "A tool call that draws what a view draws: query (args method, params), describe_app (domain), get_record (uri) or list_records (collection).",
"type": "object",
"properties": {
"name": {
"enum": [
"query",
"describe_app",
"get_record",
"list_records"
]
},
"args": {
"type": "object"
}
},
"required": [
"name"
]
},
"tab": {
"type": "string"
},
"pager": {
"const": true
},
"under": {
"type": "string",
"pattern": "^/"
}
},
"required": [
"path",
"call"
]
}
},
"push": {
"type": "object",
"properties": {
"register": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"service": {
"type": "string"
},
"input": {}
},
"required": [
"method",
"service"
]
},
"unregister": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"service": {
"type": "string"
},
"input": {}
},
"required": [
"method",
"service"
]
},
"open": {
"type": "array",
"items": {
"type": "object",
"properties": {
"when": {
"type": "object",
"minProperties": 1
},
"path": {
"type": "string",
"pattern": "^/"
}
},
"required": [
"when",
"path"
]
}
}
},
"required": [
"register",
"unregister"
]
},
"refresh": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"service": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"method",
"service"
]
},
"permissions": {
"type": "array",
"minItems": 1,
"maxItems": 8,
"items": {
"type": "object",
"properties": {
"include": {
"type": "string"
},
"service": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"include"
]
}
},
"head": {
"type": "object",
"properties": {
"siteName": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"image": {
"type": "string",
"pattern": "^https://"
},
"imageAlt": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"twitter": {
"type": "string",
"pattern": "^@[A-Za-z0-9_]{1,15}$"
}
},
"additionalProperties": false,
"required": [
"siteName"
]
},
"frame": {
"$ref": "#/$defs/place.hud.frame.main"
},
"pages": {
"type": "array",
"maxItems": 64,
"items": {
"$ref": "#/$defs/place.hud.page.main"
}
},
"signIn": {
"$ref": "#/$defs/place.hud.signIn.main"
}
},
"required": [
"domain",
"name",
"tabs"
],
"$defs": {
"place.hud.frame.main": {
"type": "object",
"properties": {
"destinations": {
"type": "string",
"description": "What the navigation lists: tabs, the app's tabs, drawn as a bottom bar, a rail or a sidebar by the window's width.",
"maxLength": 32,
"examples": [
"tabs"
]
},
"action": {
"$ref": "#/$defs/place.hud.frame.action",
"description": "The app's one primary action, drawn signed in."
},
"account": {
"$ref": "#/$defs/place.hud.frame.account",
"description": "The account's area."
},
"links": {
"type": "array",
"items": {
"$ref": "#/$defs/place.hud.frame.link"
},
"description": "Links drawn at the navigation's foot.",
"maxItems": 12
},
"aside": {
"$ref": "#/$defs/place.hud.frame.aside",
"description": "A screen drawn beside the main column where the window has the room."
},
"sizes": {
"$ref": "#/$defs/place.hud.frame.sizes",
"description": "The widths of the column a view's measure asks for."
},
"bands": {
"$ref": "#/$defs/place.hud.frame.bands",
"description": "The window widths at which the navigation changes."
}
},
"additionalProperties": false,
"description": "An operator's app file's frame (frame in <HUD_APPS>/<domain>.json): how a client's shell draws the app's navigation, its one primary action, the account's area, footer links and an aside around its screens. An object in a file, not a method, so it needs no auth. hud_core::operator holds a frame to this lexicon, then to its own rules: no key but these, each call drawn by a view, each icon one a shell draws."
},
"place.hud.frame.action": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Its label.",
"maxLength": 400,
"minLength": 1
},
"icon": {
"type": "string",
"description": "Its icon.",
"maxLength": 32,
"examples": [
"feed",
"search",
"compass",
"notification",
"people",
"settings",
"plus",
"photo",
"imagePlus",
"logOut",
"logIn",
"grid",
"heart",
"star",
"comment",
"activity",
"repo",
"issue",
"pull",
"release"
]
},
"call": {
"$ref": "#/$defs/place.hud.frame.call",
"description": "The call it opens, drawn by a view, as a screen on the tab on show."
}
},
"additionalProperties": false,
"required": [
"label",
"icon",
"call"
],
"description": "The app's one primary action: a filled button in the sidebar, an icon in the rail; not drawn in the bottom bar's band, where the screen's own bar has it."
},
"place.hud.frame.call": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tool's name: query, describe_app, get_record or list_records.",
"maxLength": 64
},
"args": {
"description": "The tool's arguments."
}
},
"additionalProperties": false,
"required": [
"name"
],
"description": "A tool call, as an app's tabs and routes name one."
},
"place.hud.frame.account": {
"type": "object",
"properties": {
"picture": {
"$ref": "#/$defs/place.hud.frame.picture",
"description": "Where the account's picture is read, and the tab it is drawn on."
},
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/place.hud.frame.item"
},
"description": "What the account's area lists.",
"maxItems": 8
}
},
"additionalProperties": false,
"description": "The account's area: its picture and its items."
},
"place.hud.frame.picture": {
"type": "object",
"properties": {
"tab": {
"type": "string",
"description": "The label of the tab whose icon it becomes.",
"maxLength": 400
},
"call": {
"$ref": "#/$defs/place.hud.frame.call",
"description": "A query call that reads it."
},
"at": {
"type": "string",
"description": "A dotted path to the picture in the query's answer.",
"maxLength": 1000,
"minLength": 1
},
"name": {
"type": "string",
"description": "A dotted path to the account's name in the same answer, for its row among the accounts.",
"maxLength": 1000,
"minLength": 1
},
"handle": {
"type": "string",
"description": "A dotted path to the account's handle in the same answer, for its row among the accounts.",
"maxLength": 1000,
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"tab",
"call",
"at"
],
"description": "The account's picture: read once from a query's answer (the account's profile, called as each account the app is signed in to), it becomes the icon of a tab, and with its name and handle beside it a row of the accounts the host lists (a view's Accounts)."
},
"place.hud.frame.item": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Its label.",
"maxLength": 400,
"minLength": 1
},
"icon": {
"type": "string",
"description": "Its icon.",
"maxLength": 32,
"examples": [
"feed",
"search",
"compass",
"notification",
"people",
"settings",
"plus",
"photo",
"imagePlus",
"logOut",
"logIn",
"grid",
"heart",
"star",
"comment",
"activity",
"repo",
"issue",
"pull",
"release"
]
},
"call": {
"$ref": "#/$defs/place.hud.frame.call",
"description": "The screen it opens, drawn by a view."
},
"host": {
"type": "string",
"description": "What the host does: signOut, drawn signed in; signIn, drawn signed out.",
"maxLength": 32,
"examples": [
"signOut",
"signIn"
]
},
"about": {
"type": "string",
"description": "A line drawn over a host item.",
"maxLength": 1000,
"minLength": 1
}
},
"additionalProperties": false,
"description": "One of the account's items: a screen of the app's (label, icon and call), drawn signed in, or one the host draws (host)."
},
"place.hud.frame.link": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Its label.",
"maxLength": 400,
"minLength": 1
},
"href": {
"type": "string",
"description": "Where it goes: a path starting with / or an https URL.",
"maxLength": 2000
}
},
"additionalProperties": false,
"required": [
"label",
"href"
],
"description": "A link at the navigation's foot."
},
"place.hud.frame.aside": {
"type": "object",
"properties": {
"call": {
"$ref": "#/$defs/place.hud.frame.call",
"description": "The screen, drawn by a view."
},
"width": {
"type": "integer",
"description": "Its width in CSS pixels.",
"minimum": 200,
"maximum": 480,
"default": 320
}
},
"additionalProperties": false,
"required": [
"call"
],
"description": "A screen drawn right of the main column."
},
"place.hud.frame.sizes": {
"type": "object",
"properties": {
"content": {
"type": "integer",
"description": "The column of a view whose measure is content.",
"minimum": 320,
"maximum": 1600,
"default": 600
},
"wide": {
"type": "integer",
"description": "The column of a view whose measure is wide; no narrower than content.",
"minimum": 320,
"maximum": 2400,
"default": 935
}
},
"additionalProperties": false,
"description": "The widths, in CSS pixels, of the column a view's measure asks for."
},
"place.hud.frame.bands": {
"type": "object",
"properties": {
"rail": {
"type": "integer",
"description": "From this width, a rail in place of a bottom bar.",
"minimum": 320,
"maximum": 4000,
"default": 600
},
"sidebar": {
"type": "integer",
"description": "From this width, a labelled sidebar; wider than rail.",
"minimum": 320,
"maximum": 4000,
"default": 1200
}
},
"additionalProperties": false,
"description": "The window widths, in CSS pixels, at which the navigation changes."
},
"place.hud.page.main": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Its path on the app's site, as /support/terms: segments of a to z, 0 to 9, -, _ and ., with no query and no token.",
"maxLength": 200,
"minLength": 2
},
"title": {
"type": "string",
"description": "Its title: its screen's, and its HTML head's on the app's name.",
"maxLength": 320,
"minLength": 1
},
"description": {
"type": "string",
"description": "What it says, for a search result or a link's preview.",
"maxLength": 1250,
"minLength": 1
},
"markdown": {
"type": "string",
"description": "Its text's file, relative to the app file's directory, as pages/terms.md: Markdown, GitHub's (GFM), whose links to the app's own paths (/support/privacy) open them on its site.",
"maxLength": 200,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"path",
"title",
"markdown"
],
"description": "One of an operator's app file's pages (pages in <HUD_APPS>/<domain>.json): a page of the app's own, its terms or its privacy policy, its text Markdown in a file beside the app file, drawn by the app's clients at its path inside the frame, and answered by describe_app with page. An object in a file, not a method, so it needs no auth. hud_core::operator holds each page to this lexicon, then to its own rules: a plain path no other page, tab or route has, its file under HUD_APPS."
},
"place.hud.signIn.main": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The screen's heading.",
"maxLength": 400,
"minLength": 1
},
"text": {
"type": "string",
"description": "A line under the heading, its links written as Markdown's [label](href), each href a path of the app's own site or an https URL.",
"maxLength": 2000,
"minLength": 1
},
"placeholder": {
"type": "string",
"description": "What the handle's field holds while it is empty.",
"maxLength": 200,
"minLength": 1
},
"legal": {
"type": "string",
"description": "A line under the form, as the terms signing in agrees to; its links as text's.",
"maxLength": 2000,
"minLength": 1
},
"create": {
"$ref": "#/$defs/place.hud.signIn.create",
"description": "Making an account, offered under the form."
},
"typeahead": {
"$ref": "#/$defs/place.hud.signIn.typeahead",
"description": "Who matches what is typed of a handle, offered under the field."
}
},
"additionalProperties": false,
"required": [
"title"
],
"description": "An operator's app file's sign-in screen (signIn in <HUD_APPS>/<domain>.json): what its clients' own sign-in screen says, and where it finds accounts as a handle is typed. With it, HUD sends the app's web clients (their redirect URI at the app's domain) straight on to the account's server, as it does its own app. An object in a file, not a method, so it needs no auth. hud_core::operator holds it to this lexicon, then to its own rules: no key but these, the typeahead's url an https origin, each link a path or an https URL."
},
"place.hud.signIn.create": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "A line before its button.",
"maxLength": 400,
"minLength": 1
},
"label": {
"type": "string",
"description": "Its button's label.",
"maxLength": 400,
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"label"
],
"description": "Making an account: HUD asks its sign-up PDS for one (prompt=create), as its own sign-in page's Create one does."
},
"place.hud.signIn.typeahead": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The XRPC host, an https origin, as https://typeahead.waow.tech.",
"maxLength": 2000
},
"method": {
"type": "string",
"description": "The query's NSID."
},
"param": {
"type": "string",
"description": "The parameter what is typed is given in.",
"maxLength": 100,
"minLength": 1
},
"params": {
"description": "Its other parameters, an object of strings, numbers and booleans, as { \"limit\": 5 }."
},
"items": {
"type": "string",
"description": "A dotted path to the list of accounts in its answer.",
"maxLength": 1000,
"minLength": 1
},
"did": {
"type": "string",
"description": "A dotted path to an account's DID in an item.",
"maxLength": 1000,
"minLength": 1
},
"handle": {
"type": "string",
"description": "A dotted path to an account's handle in an item.",
"maxLength": 1000,
"minLength": 1
},
"name": {
"type": "string",
"description": "A dotted path to an account's name in an item.",
"maxLength": 1000,
"minLength": 1
},
"avatar": {
"type": "string",
"description": "A dotted path to an account's picture in an item, an https URL.",
"maxLength": 1000,
"minLength": 1
},
"avatarFallback": {
"type": "string",
"description": "A dotted path to the picture drawn where avatar's fails to load, an https URL.",
"maxLength": 1000,
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"url",
"method",
"param",
"items",
"did",
"handle"
],
"description": "A public query that matches accounts to what is typed, called by the client directly, as no one: GET <url>/xrpc/<method>?<param>=<typed>&<params>. As a Compose text field's suggest, but at a host of its own."
},
"place.hud.tabFirst.main": {
"type": "object",
"properties": {
"call": {
"$ref": "#/$defs/place.hud.tabFirst.call",
"description": "The query whose answer lists the items, made as the account."
},
"at": {
"type": "string",
"description": "A dotted path to the list in the query's answer (in its response), a segment @name the element of a list whose $type is name or ends #name.",
"maxLength": 1000,
"minLength": 1
},
"path": {
"type": "string",
"description": "A dotted path, in each item, to a path of the app's own site: the item's screen is that path's by the app's routes, the tab's own call at the tab's own path.",
"maxLength": 1000,
"minLength": 1
},
"after": {
"type": "string",
"description": "A procedure after which the root is chosen again, as it changes the list."
}
},
"additionalProperties": false,
"required": [
"call",
"at",
"path"
],
"description": "Where one of an operator's app file's tabs finds its root in the account's data, signed in (first, on a tab in <HUD_APPS>/<domain>.json): the screen of the first item, of a list a query answers, whose path is one of the app's screens, as Grain's Home opens the first feed the person pinned. The app's clients choose it as they draw the tab, the web shell's server for each page, so the page is that screen from its first paint; signed out, or where nothing listed has a screen, the tab's own call stands. An object in a file, not a method, so it needs no auth. hud_core::operator holds it to this lexicon, then to its own rules: no key but these, its call a query of a method's NSID, its paths dotted."
},
"place.hud.tabFirst.call": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tool's name: query.",
"maxLength": 64
},
"args": {
"description": "The query's arguments: its method, service and params."
}
},
"additionalProperties": false,
"required": [
"name"
],
"description": "A query call, as an app's tabs and routes name one."
}
}
}