Baca cakupan sumber Listening

Profil dan transport

Profil: full · Transport: stdio, http

Pilih core atau full untuk mengatur alat yang terlihat oleh klien; ini tidak mengubah izinnya. Unggahan file lokal memerlukan stdio dan tidak tersedia melalui HTTP. Atur SOSOAPI_OUTPUT_SCHEMAS=1 untuk menyertakan skema output saat penemuan. Alat mengembalikan hasil terstruktur dengan atau tanpa pengaturan itu.

Izin dan efek samping

Anotasi membantu klien menjelaskan alat. Setiap panggilan tetap memeriksa autentikasi pengguna, peran, akses sumber daya, dan izin kemampuan.

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

• /listening-api/capabilities: agent:research · data Listening yang saat ini diizinkan; sampel publik yang diindeks bersifat parsial dan bukan penyebutan akun yang terverifikasi

Kolom input

Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.

{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Output terstruktur

Skema ini menjelaskan structuredContent dalam hasil alat yang berhasil. Respons MCP juga menyertakan content dan dapat menetapkan isError saat panggilan gagal. Untuk publikasi, baca hasil akhir postingan alih-alih menganggap permintaan diterima atau respons teks sebagai konfirmasi. Operasi API yang ditautkan menjelaskan izin dan aturan percobaan ulang.

Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.

{
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "const": "hacker_news"
    },
    "query_mode": {
      "type": "string",
      "const": "literal_phrase"
    },
    "include_mode": {
      "type": "string",
      "const": "all_literal_substrings"
    },
    "exclude_mode": {
      "type": "string",
      "const": "any_literal_substring"
    },
    "item_types": {
      "type": "array",
      "items": [
        {
          "type": "string",
          "const": "story"
        },
        {
          "type": "string",
          "const": "comment"
        }
      ],
      "additionalItems": false,
      "minItems": 2,
      "maxItems": 2
    },
    "coverage": {
      "type": "string",
      "const": "partial_indexed_sample"
    },
    "exhaustive": {
      "type": "boolean",
      "const": false
    },
    "limits": {
      "type": "object",
      "properties": {
        "streams_per_workspace": {
          "type": "number",
          "const": 5
        },
        "minimum_cadence_minutes": {
          "type": "number",
          "const": 30
        },
        "lookback_days": {
          "type": "number",
          "const": 7
        },
        "content_retention_days": {
          "type": "number",
          "const": 7
        },
        "results_per_run": {
          "type": "number",
          "const": 20
        },
        "provider_gets_per_run": {
          "type": "number",
          "const": 21
        },
        "workspace_provider_gets_per_day": {
          "type": "number",
          "const": 500
        },
        "shared_searches_per_hour": {
          "type": "number",
          "const": 5000
        }
      },
      "required": [
        "streams_per_workspace",
        "minimum_cadence_minutes",
        "lookback_days",
        "content_retention_days",
        "results_per_run",
        "provider_gets_per_run",
        "workspace_provider_gets_per_day",
        "shared_searches_per_hour"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "source",
    "query_mode",
    "include_mode",
    "exclude_mode",
    "item_types",
    "coverage",
    "exhaustive",
    "limits"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Contoh panggilan alat

Contoh ini menggunakan nilai fiktif yang diperiksa terhadap skema. Ganti ID dengan yang diizinkan bagi Anda, media dengan aset siap, dan tanggal dengan waktu publikasi yang dikonfirmasi. Periksa kelayakan akun sebelum mengirim penulisan. Halaman ini tidak mengirim permintaan API.

{
  "name": "sosoapi_listening_capabilities",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "source": "hacker_news",
  "query_mode": "literal_phrase",
  "include_mode": "all_literal_substrings",
  "exclude_mode": "any_literal_substring",
  "item_types": [
    "story",
    "comment"
  ],
  "coverage": "partial_indexed_sample",
  "exhaustive": false,
  "limits": {
    "streams_per_workspace": 5,
    "minimum_cadence_minutes": 30,
    "lookback_days": 7,
    "content_retention_days": 7,
    "results_per_run": 20,
    "provider_gets_per_run": 21,
    "workspace_provider_gets_per_day": 500,
    "shared_searches_per_hour": 5000
  }
}

Operasi API yang mendasari

• /listening-api/capabilities