Get Config

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api.onetimesecret.com/doc/v3-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "v3 - Secrets API (preview) MCP server": {
    "url": "https://api.onetimesecret.com/doc/v3-api/mcp"
  }
}
Close
GET /api/incoming/config

Retrieve the incoming secrets feature configuration, including whether the feature is enabled, memo length limits, default TTL, and the list of available recipients identified by hash.

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • config object Required
      Hide config attributes Show config attributes object
      • enabled boolean Required
      • memo_max_length integer

        Maximum value is 9007199254740991. Default value is 50.

      • secret_max_length integer

        Maximum value is 9007199254740991. Default value is 10000.

      • recipients array[object]

        Default value is [] (empty).

        Hide recipients attributes Show recipients attributes object
        • digest string Required

          Minimum length is 1.

        • display_name string Required
      • default_ttl integer

        Maximum value is 9007199254740991.
  • 404 application/json

    Not Found - Resource does not exist

    Hide response attributes Show response attributes object
    • error string

      ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

    • error_type string

      Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

    • message string

      Human-readable error message (legacy/V1 shape)

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier

    • request_id string

      Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
  • 500 application/json

    Internal Server Error - Something went wrong

    Hide response attributes Show response attributes object
    • error string

      ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.

    • error_type string

      Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")

    • message string

      Human-readable error message (legacy/V1 shape)

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier

    • request_id string

      Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
GET /api/incoming/config 
curl \
 --request GET 'https://uk.onetimesecret.com/api/incoming/config'
Response examples (200) 
{
  "config": {
    "enabled": true,
    "memo_max_length": 50,
    "secret_max_length": 10000,
    "recipients": [
      {
        "digest": "string",
        "display_name": "string"
      }
    ],
    "default_ttl": 42
  }
}
Response examples (404) 
{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}
Response examples (500) 
{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}