seerr-cli/seerr-cli.schema.json at main · electather/seerr-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/electather/seerr-cli/main/seerr-cli.schema.json",
  "title": "seerr-cli configuration",
  "description": "Configuration file for seerr-cli (~/.seerr-cli.yaml).",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "seerr": {
      "description": "Seerr instance connection settings.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "server": {
          "description": "Base URL of your Seerr instance (e.g. https://seerr.example.com). The /api/v1 path is appended automatically.",
          "type": "string",
          "examples": [
            "https://seerr.example.com"
          ]
        },
        "api_key": {
          "description": "Seerr API key. Generate one in Seerr → Settings → API Keys.",
          "type": "string"
        }
      }
    },
    "mcp": {
      "description": "MCP server settings (seerr-cli mcp serve).",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transport": {
          "description": "Transport protocol for the MCP server.",
          "type": "string",
          "enum": [
            "stdio",
            "http"
          ],
          "default": "stdio"
        },
        "addr": {
          "description": "Bind address for the HTTP transport (host:port).",
          "type": "string",
          "default": ":8811",
          "examples": [
            ":8811",
            "127.0.0.1:8811"
          ]
        },
        "auth_token": {
          "description": "Bearer token required by HTTP clients. Omit only when using --no-auth.",
          "type": "string"
        },
        "no_auth": {
          "description": "Disable authentication entirely. Only use in trusted environments.",
          "type": "boolean",
          "default": false
        },
        "tls_cert": {
          "description": "Path to TLS certificate file (PEM). Required together with tls_key to enable HTTPS.",
          "type": "string"
        },
        "tls_key": {
          "description": "Path to TLS private key file (PEM). Required together with tls_cert to enable HTTPS.",
          "type": "string"
        },
        "cors": {
          "description": "Enable CORS headers. Required for browser-based clients such as claude.ai.",
          "type": "boolean",
          "default": false
        },
        "allow_api_key_query_param": {
          "description": "Accept the Seerr API key via the api_key query parameter in addition to the X-Api-Key header. Opt-in; disabled by default. HTTP transport only.",
          "type": "boolean",
          "default": false
        },
        "log_file": {
          "description": "Path to log file. For stdio transport this is the only way to capture logs.",
          "type": "string"
        },
        "log_level": {
          "description": "Minimum log level to emit.",
          "type": "string",
          "enum": [
            "debug",
            "info",
            "warn",
            "error"
          ],
          "default": "info"
        },
        "log_format": {
          "description": "Log output format.",
          "type": "string",
          "enum": [
            "text",
            "json"
          ],
          "default": "text"
        }
      }
    }
  }
}