AI Activate

Get Mcp Volume Config

Get MCP query-scope configuration for a single indexed volume.

get/ai_activate/indexes/{volume_id}/mcp

Request

Path parameters

volume_idstring required

Response

MCP configuration retrieved successfully

mcp_enabledboolean required

Whether the MCP server is enabled for this volume.

allowed_file_extensionsstring[]

File extensions the MCP server filters results to. Empty list returns all file types.

periodinteger nullable

Rolling-window filter: only include files modified within the last N days. null means 'all time'. Translated to NOC's doc_mod_begin_date / doc_mod_end_date (begin = today - period, end = today) at write time.

ignore_sidsstring[]

Security identifiers (SIDs) the MCP server ignores when evaluating ALLOW permissions. Propagated to NOC's search spec ignore_sids field which Hyrule uses at query time.

include_pathsstring[]

Paths the MCP server includes when returning results. Read from NOC's search spec.

exclude_pathsstring[]

Paths the MCP server excludes when returning results. Read from NOC's search spec.

volume_namestring nullable

Human-readable volume name from NOC's inventory. Null when unavailable.

file_countinteger nullable

Number of files in the volume inventory. Null until inventory is ready.

Example response

{
  "allowed_file_extensions": [
    "pdf",
    "docx"
  ],
  "period": 7,
  "ignore_sids": [
    "S-1-5-21-1004336348-1177238915-682003330-512",
    "S-1-1-0"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.