MSP-1 schema

description

Provides a human-readable summary that explains what an MSP-1 resource is about, what it covers, and why it exists.

MSP-1 v1.0.2 • Core term

description schema definition

Machine-readable structure supporting either a lean description string or a structured description object.

description schema JSON


{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://msp-1.org/schema/description/description.json",
  "title": "MSP-1 Description Schema",
  "description": "Schema for representing a human-readable description of an MSP-1 resource, either as a concise string or as a structured description object.",
  "$comment": "MSP-1 v1.0.2 allows both the lean string form and the structured object form. For object form, short is required. For string form, the string itself serves as the short description.",
  "oneOf": [
    {
      "type": "string",
      "minLength": 1,
      "description": "A concise, single-paragraph natural-language summary of the resource."
    },
    {
      "type": "object",
      "properties": {
        "short": {
          "type": "string",
          "minLength": 1,
          "description": "A concise description intended for previews, cards, summaries, and primary AI interpretation."
        },

        "long": {
          "type": "string",
          "description": "An expanded descriptive narrative providing additional detail, context, or background."
        },

        "alt": {
          "type": "array",
          "description": "Optional alternate descriptions, such as simplified, accessibility-focused, or domain-specific variants.",
          "items": {
            "type": "string"
          }
        },

        "interpretiveFrame": {
          "type": "string",
          "description": "Optional framing statement that helps agents understand how to contextualize the description."
        },

        "language": {
          "type": "string",
          "description": "Language code for the description block."
        },

        "lastUpdated": {
          "type": "string",
          "format": "date",
          "description": "Date the description text was last updated or reviewed."
        }
      },
      "required": ["short"],
      "additionalProperties": false
    }
  ],
  "examples": [
    "A concise technical overview of the MSP-1 semantic protocol structure.",
    {
      "short": "A concise technical overview of the MSP-1 semantic protocol structure.",
      "long": "This resource explains the core structure, purpose, and implementation logic of the MSP-1 semantic protocol."
    }
  ]
}


 

Schema notes

The canonical MSP-1 v1.0.2 form for description may be either a concise string or a structured object with short as the required field.

description should not be confused with name, intent, or interpretiveFrame. name labels the resource; description summarizes what it is; intent explains why it exists or how it should be used; interpretiveFrame guides contextual interpretation.