Tools, helper endpoints, and playground

Summary

The public MCP helper endpoints expose tool definitions, category groupings, platform-specific configs, and direct playground execution so you can validate integrations before deploying them.

Helper endpoints

Method	Path	Purpose
`GET`	`/api/v2/mcp/status`	Inspect package name, install command, tool count, and supported platforms
`GET`	`/api/v2/mcp/config`	Generate platform-specific config
`GET`	`/api/v2/mcp/tools`	Return tool definitions and category groupings
`POST`	`/api/v2/mcp/playground`	Execute a tool directly for testing

Tool categories

The tool definition file groups public tools into categories such as:

Search
Discovery
Video and segment inspection
Prompt runs
Prompt management
Cloud connectors
Import jobs
Index management
Video management
Exports
Webhooks

Representative workflows include:

searching an index with search_videos, search_videos_by_image, or multimodal_search
building prompts with create_prompt and test_prompt_schema
executing and monitoring runs with execute_prompt, get_prompt_run_status, and get_prompt_run_results
operating imports, exports, connectors, and webhooks without leaving the MCP client

Status response

GET /api/v2/mcp/status returns fields such as:

server_name
server_version
package_name
npm_install_command
documentation_url
tools_count
supported_platforms

Tool discovery response

GET /api/v2/mcp/tools returns:

total_count
tools
categories

Each tool includes a public input schema that mirrors the MCP SDK Tool definition shape.

Playground execution

The playground endpoint accepts:

{
  "tool_name": "search_videos",
  "arguments": {
    "index_id": "idx_archive",
    "query": "reporter outside a station entrance",
    "top_k": 5
  }
}

The response includes:

tool_name
success
result
error
execution_time_ms

The controller also enforces explicit scope rules. Read-only tools require read-level capability, and mutating tools require write.

Structured playground payloads

For several tool families, the controller wraps results in structuredContent plus text content so clients can render both machine-readable and human-readable output cleanly.

Tip

Use the playground to validate argument shapes and output structure before you hand the server to an agent or a production client.

Custom clients and HTTP transport

Go to previous page