Soracom Knowledge

Fetch full markdown for a SORACOM documentation page. Also resolves API schema links. Exact URLs are attempted first.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "pattern": "^(http://|https://)",
      "description": "A search-result URL, or the full URL of a `#/schema/<Name>` link from search_api_docs. Must start with http:// or https://; pass it exactly as returned."
    }
  },
  "required": [
    "url"
  ]
}

Search SORACOM API documentation, CLI references, and SAM permissions. Use for exact API endpoints, soracom-cli commands, or SAM permission strings. Use search_soracom_docs for service guides, console how-tos, pricing, or IoT recipes. Use get_document on `#/schema/<Name>` links in results to read full API schema fields.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 1000,
      "description": "Natural-language query or API endpoint name. Optional when tag, method, or path is supplied; omit to browse filtered operations."
    },
    "tag": {
      "type": "string",
      "maxLength": 128,
      "description": "Optional OpenAPI tag such as 'Sim', 'DataEntry', 'Stats', or 'Query'. Exact, case-insensitive; discover valid tags from result api_tag fields."
    },
    "method": {
      "type": "string",
      "maxLength": 128,
      "description": "Optional HTTP method to narrow results (e.g. 'GET', 'POST'). Exact, case-insensitive match."
    },
    "path": {
      "type": "string",
      "maxLength": 128,
      "description": "Optional API path fragment, matched as a case-insensitive substring excluding the version prefix — e.g. '/sims' or 'subscribers', not '/v1/sims'."
    },
    "search_mode": {
      "type": "string",
      "enum": [
        "hybrid",
        "keyword",
        "semantic"
      ],
      "default": "hybrid",
      "description": "Search strategy: 'hybrid' combines keyword and vector search; 'keyword' matches exact API paths, operationIds, and parameter names; 'semantic' uses vector similarity only."
    },
    "language": {
      "type": "string",
      "enum": [
        "Japanese",
        "English"
      ],
      "description": "Documentation language. Omit to auto-detect; set only to pin one language."
    },
    "max_results": {
      "type": "integer",
      "minimum": 1,
      "maximum": 32,
      "default": 16,
      "description": "Maximum results to return (1-32). Increase when exploring."
    }
  }
}

Search SORACOM service documentation, guides, and console how-to articles (user site, service overviews and pricing, IoT recipes). Covers SORACOM services, subscription plans, User Console operations, changelogs, blogs, devices, IoT Store, partners, contract terms, and use cases. Use search_api_docs for API references, CLI commands, or SAM permissions.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 1000,
      "description": "Search query in natural language related to SORACOM services or console usage"
    },
    "document_names": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "blog.soracom.com",
          "changelog.soracom.io",
          "changelog.soracom.io/ja",
          "developers.soracom.io",
          "iot-template-gallery.soracom.io",
          "iot-template-gallery.soracom.jp",
          "iot-usecase.com",
          "soracom.io",
          "soracom.io/terms",
          "soracom.jp/iot-recipes",
          "soracom.jp/iot_basics",
          "soracom.jp/partners",
          "soracom.jp/services",
          "soracom.jp/store",
          "soracom.jp/support_partners/certified_device",
          "soracom.jp/terms",
          "support.soracom.io/hc/en-us",
          "support.soracom.io/hc/ja",
          "users.soracom.io"
        ]
      },
      "description": "Optional document-name scope filter. Omit when unsure; narrowing too early can hide relevant results. Each document has a fixed language; only in-scope languages are searched. Available documents:\n- blog.soracom.com (Japanese): Official blog: announcements, tutorials, event reports, and customer stories.\n- changelog.soracom.io (English): New feature releases, end-of-service notices, and pricing/spec changes.\n- changelog.soracom.io/ja (Japanese): New feature releases, end-of-service notices, and pricing/spec changes.\n- developers.soracom.io (English): SORACOM Developer Site docs.\n- iot-template-gallery.soracom.io (English): Ready-to-use IoT solution template setup guides.\n- iot-template-gallery.soracom.jp (Japanese): Ready-to-use IoT solution template setup guides.\n- iot-usecase.com (Japanese): IoT use cases showing SORACOM across industries.\n- soracom.io (English): Official blog: announcements, tutorials, event reports, and customer stories.\n- soracom.io/terms (English): Contract terms and conditions for SORACOM services in English, by region.\n- soracom.jp/iot-recipes (Japanese): Step-by-step IoT solution recipes with SORACOM.\n- soracom.jp/iot_basics (Japanese): Introductory IoT fundamentals and related technologies.\n- soracom.jp/partners (Japanese): SORACOM Partner Space and certified partner information.\n- soracom.jp/services (Japanese): SORACOM service overviews and pricing.\n- soracom.jp/store (Japanese): SORACOM IoT Store devices and starter kits.\n- soracom.jp/support_partners/certified_device (Japanese): SORACOM certified and compatible IoT device catalog.\n- soracom.jp/terms (Japanese): Contract terms and conditions (利用規約) for SORACOM services in Japanese.\n- support.soracom.io/hc/en-us (English): SORACOM support FAQs.\n- support.soracom.io/hc/ja (Japanese): SORACOM support FAQs.\n- users.soracom.io (Japanese): SORACOM User Site docs for service usage and configuration."
    },
    "search_mode": {
      "type": "string",
      "enum": [
        "hybrid",
        "keyword",
        "semantic"
      ],
      "default": "hybrid",
      "description": "Search strategy: 'hybrid' combines keyword and vector search; 'keyword' matches exact tokens; 'semantic' uses vector similarity only."
    },
    "language": {
      "type": "string",
      "enum": [
        "English",
        "Japanese"
      ],
      "description": "Documentation language. Omit to auto-detect; set only to pin one language. This does not imply the user's market — use market for that."
    },
    "market": {
      "type": "string",
      "enum": [
        "Global",
        "Japan"
      ],
      "description": "End-user's deployment market, not the query language. Omit if unknown."
    },
    "max_results": {
      "type": "integer",
      "minimum": 1,
      "maximum": 32,
      "default": 16,
      "description": "Maximum results to return (1-32). Increase when exploring."
    }
  },
  "required": [
    "query"
  ]
}