API

/web_api/mcp_server_snapshot/capture

/web_api/mcp_server_snapshot/capture ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.request.json

REQUEST /web_api/mcp_server_snapshot/capture

NameTypeRequiredConstraint
mcp_server_idintegerYesminimum 1

Other top-level fields are not allowed.

Response ​

main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.response.json

RESPONSE /web_api/mcp_server_snapshot/capture

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
mcp_server_snapshot_idintegerNominimum 0
mcp_server_idintegerNominimum 0
team_idintegerNominimum 0
project_idintegerNominimum 0
snapshot_statusenumNo"DRAFT", "FIXED"
protocol_revisionstringNo-
snapshot_transportenumNo"STREAMABLE_HTTP"
mcp_server_auth_kindenumNo"BEARER", "OAUTH"
snapshot_completenessenumNo"COMPLETE_UNVERIFIED", "INCOMPLETE", "ERROR"
catalog_hashstringNo-
server_namestring | nullNomaxLength 255
server_versionstring | nullNomaxLength 255
instructionsstring | nullNo-
client_namestring | nullNomaxLength 255
client_versionstring | nullNomaxLength 255
protocol_adapter_versionstringNomaxLength 128
redaction_policy_versionstringNomaxLength 32
credential_generationintegerNominimum 0
access_subjectstring | nullNomaxLength 512
captured_atstringNo-
fixed_atstringNo-
created_by_user_idintegerNominimum 0
created_atstringNo-
updated_atstringNo-

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.request.json",
  "title": "REQUEST /web_api/mcp_server_snapshot/capture",
  "type": "object",
  "additionalProperties": false,
  "required": ["mcp_server_id"],
  "properties": {
    "mcp_server_id": { "type": "integer", "minimum": 1 }
  }
}
Response: main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_mcp_testing/mcp_server_snapshot/capture.response.json",
  "title": "RESPONSE /web_api/mcp_server_snapshot/capture",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.json" },
    {
      "type": "object",
      "properties": {
        "api_result": { "$ref": "main-app://schemas/api_mcp_testing/mcp_server_snapshot/row.json" }
      }
    }
  ]
}
Fragment: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}
Fragment: main-app://schemas/api_mcp_testing/mcp_server_snapshot/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_mcp_testing/mcp_server_snapshot/row.json",
  "title": "Row mcp_server_snapshot",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "mcp_server_snapshot_id": {
      "type": "integer",
      "minimum": 0
    },
    "mcp_server_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "snapshot_status": {
      "type": "string",
      "enum": [
        "DRAFT",
        "FIXED"
      ]
    },
    "protocol_revision": {
      "type": "string"
    },
    "snapshot_transport": {
      "type": "string",
      "enum": [
        "STREAMABLE_HTTP"
      ]
    },
    "mcp_server_auth_kind": {
      "type": "string",
      "enum": [
        "BEARER",
        "OAUTH"
      ]
    },
    "snapshot_completeness": {
      "type": "string",
      "enum": [
        "COMPLETE_UNVERIFIED",
        "INCOMPLETE",
        "ERROR"
      ]
    },
    "catalog_hash": {
      "type": "string"
    },
    "server_name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "server_version": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "instructions": {
      "type": [
        "string",
        "null"
      ]
    },
    "client_name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "client_version": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "protocol_adapter_version": {
      "type": "string",
      "maxLength": 128
    },
    "redaction_policy_version": {
      "type": "string",
      "maxLength": 32
    },
    "credential_generation": {
      "type": "integer",
      "minimum": 0
    },
    "access_subject": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 512
    },
    "captured_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "fixed_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "created_by_user_id": {
      "type": "integer",
      "minimum": 0
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?