Ruby MCP reference

toolMCPv0.1.0.alpha.2

`tmux_capabilities`

tmux_capabilities()

tool[source]¶

Discover the fixed endpoint, server binding, enabled tools, criteria schema and limits. Acquires metadata; starts no daemon.

MCP request method: tools/call Send tmux_capabilities as the tool name, with the arguments below.
Tool selection: Enabled by default.

Arguments#

No named arguments.

additionalProperties: false

Result#

Returns object | object

Matches exactly one variant.

Variant 1: object #

additionalProperties
false
- data: object Required #
  
  additionalProperties
  false
  - authored_run: object Required #
    
    additionalProperties
    false
    - authorization: "exact_generation_at_queue_grant" Required #
    - availability: "conditional" | "unsupported" Required #
    - descendant_termination: "unobserved" Required #
    - enrollment: "explicit_source" Required #
    - persistent_shell_changes: false Required #
    - requirements: Array<string> Required #
    - shell_profile: "zsh-5.9-zle" Required #
    - stdin: "closed" Required #
  - criteria_schema: object Required #
  - enabled_tools: Array<string> Required #
  - endpoint: string Required #
  - limits: object Required #
    - Additional properties: number #
  - observation: object Required #
    
    additionalProperties
    false
    - history_continuity: "unknown" Required #
    - process_cursor: "conditional" | "unsupported" Required #
    - requirements: Array<string> Required #
    - screen: "bounded_rows" Required #
    - wait_conditions: Array<"screen_contains" | "process_exit"> Required #
  - owns_daemon: false Required #
  - resource_subscriptions: false Required #
  - server_identity: object Required #
    
    additionalProperties
    false
    - generation: string Required #
    - pid: integer Required #
    - start_time: integer Required #
    - tmux_version: string Required #
- ok: true Required #
Variant 2: object #

additionalProperties
false
- error: object Required #
  
  additionalProperties
  false
  - code: string Required #
  - delivery: "not_sent" | "possibly_sent" | "observed" Required #
  - effects: object Optional #
    
    additionalProperties
    false
    - created: Array<object | object | object | object> Required #
      
      maxItems
      3
      - Items: object | object | object | object #
        
        Matches exactly one variant.
        
        Variant 1: object #
        
        additionalProperties
        false
        
        generation: string Required #
        
        minLength
        1
        maxLength
        128
        
        id: string Required #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
        
        kind: "session" Required #
        
        Variant 2: object #
        
        additionalProperties
        false
        
        generation: string Required #
        
        minLength
        1
        maxLength
        128
        
        id: string Required #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
        
        kind: "window" Required #
        
        Variant 3: object #
        
        additionalProperties
        false
        
        generation: string Required #
        
        minLength
        1
        maxLength
        128
        
        id: string Required #
        
        maxLength
        32
        pattern
        "^%[0-9]+$"
        
        kind: "pane" Required #
        
        Variant 4: object #
        
        additionalProperties
        false
        
        generation: string Required #
        
        minLength
        1
        maxLength
        128
        
        id: string Required #
        
        maxLength
        32
        pattern
        "^@[0-9]+$"
        
        index: integer Required #
        
        minimum
        0
        
        kind: "window_link" Required #
        
        session_id: string Required #
        
        maxLength
        32
        pattern
        "^\\$[0-9]+$"
    - state: "none" | "known" | "unknown" Required #
  - message: string Required #
- ok: false Required #

Annotations#

destructiveHint: false
idempotentHint: false
openWorldHint: false
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {},
  "required": [],
  "type": "object"
}

Output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "data": {
          "additionalProperties": false,
          "properties": {
            "authored_run": {
              "additionalProperties": false,
              "properties": {
                "authorization": {
                  "const": "exact_generation_at_queue_grant"
                },
                "availability": {
                  "enum": [
                    "conditional",
                    "unsupported"
                  ]
                },
                "descendant_termination": {
                  "const": "unobserved"
                },
                "enrollment": {
                  "const": "explicit_source"
                },
                "persistent_shell_changes": {
                  "const": false
                },
                "requirements": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "shell_profile": {
                  "const": "zsh-5.9-zle"
                },
                "stdin": {
                  "const": "closed"
                }
              },
              "required": [
                "availability",
                "shell_profile",
                "enrollment",
                "authorization",
                "stdin",
                "persistent_shell_changes",
                "descendant_termination",
                "requirements"
              ],
              "type": "object"
            },
            "criteria_schema": {
              "type": "object"
            },
            "enabled_tools": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "endpoint": {
              "type": "string"
            },
            "limits": {
              "additionalProperties": {
                "type": "number"
              },
              "type": "object"
            },
            "observation": {
              "additionalProperties": false,
              "properties": {
                "history_continuity": {
                  "const": "unknown"
                },
                "process_cursor": {
                  "enum": [
                    "conditional",
                    "unsupported"
                  ]
                },
                "requirements": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "screen": {
                  "const": "bounded_rows"
                },
                "wait_conditions": {
                  "items": {
                    "enum": [
                      "screen_contains",
                      "process_exit"
                    ]
                  },
                  "type": "array"
                }
              },
              "required": [
                "screen",
                "history_continuity",
                "process_cursor",
                "requirements",
                "wait_conditions"
              ],
              "type": "object"
            },
            "owns_daemon": {
              "const": false
            },
            "resource_subscriptions": {
              "const": false
            },
            "server_identity": {
              "additionalProperties": false,
              "properties": {
                "generation": {
                  "type": "string"
                },
                "pid": {
                  "type": "integer"
                },
                "start_time": {
                  "type": "integer"
                },
                "tmux_version": {
                  "type": "string"
                }
              },
              "required": [
                "generation",
                "pid",
                "start_time",
                "tmux_version"
              ],
              "type": "object"
            }
          },
          "required": [
            "endpoint",
            "server_identity",
            "enabled_tools",
            "criteria_schema",
            "limits",
            "owns_daemon",
            "resource_subscriptions",
            "authored_run",
            "observation"
          ],
          "type": "object"
        },
        "ok": {
          "const": true
        }
      },
      "required": [
        "ok",
        "data"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "error": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "delivery": {
              "enum": [
                "not_sent",
                "possibly_sent",
                "observed"
              ]
            },
            "effects": {
              "additionalProperties": false,
              "properties": {
                "created": {
                  "items": {
                    "oneOf": [
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^\\$[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "session"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^@[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "window"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^%[0-9]+$",
                            "type": "string"
                          },
                          "kind": {
                            "const": "pane"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id"
                        ],
                        "type": "object"
                      },
                      {
                        "additionalProperties": false,
                        "properties": {
                          "generation": {
                            "maxLength": 128,
                            "minLength": 1,
                            "type": "string"
                          },
                          "id": {
                            "maxLength": 32,
                            "pattern": "^@[0-9]+$",
                            "type": "string"
                          },
                          "index": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "kind": {
                            "const": "window_link"
                          },
                          "session_id": {
                            "maxLength": 32,
                            "pattern": "^\\$[0-9]+$",
                            "type": "string"
                          }
                        },
                        "required": [
                          "generation",
                          "kind",
                          "id",
                          "session_id",
                          "index"
                        ],
                        "type": "object"
                      }
                    ]
                  },
                  "maxItems": 3,
                  "type": "array"
                },
                "state": {
                  "enum": [
                    "none",
                    "known",
                    "unknown"
                  ]
                }
              },
              "required": [
                "state",
                "created"
              ],
              "type": "object"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message",
            "delivery"
          ],
          "type": "object"
        },
        "ok": {
          "const": false
        }
      },
      "required": [
        "ok",
        "error"
      ],
      "type": "object"
    }
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

`tmux_capabilities`

Arguments#

Result#

Annotations#

Protocol data#