Skip to main content
Glama

VisioForge SDK Assistant

get_code_example

Get a code example for a common VisioForge SDK scenario. Returns complete, working C# code snippets that demonstrate how to use the SDK for tasks like video capture, RTSP streaming, media playback, and more.

Input Schema

NameRequiredDescriptionDefault
scenarioYesScenario name. Available: 'webcam-capture' (capture from webcam to MP4), 'rtsp-playback' (play RTSP stream), 'rtsp-to-mp4' (record RTSP to MP4 file), 'webcam-to-rtmp' (stream webcam to RTMP/YouTube/Facebook), 'file-playback' (play a media file), 'video-editing' (basic video editing), 'screen-capture' (capture screen to file), 'media-info' (read media file information), 'pipeline-basic' (build a basic media block pipeline), 'virtual-source' (generate test video/audio), 'hls-streaming' (stream to HLS), 'audio-capture' (capture audio only)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full behavioral burden. It discloses that the tool returns complete, working C# code snippets, which is useful return-behavior context, but it does not state that the operation is read-only, describe error behavior, or mention any limitations such as static documentation retrieval.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the core action and resource. Every sentence contributes useful context about the return type and supported scenario examples, with no unnecessary wording.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is simple: one required scenario parameter with a fully documented schema, no annotations, and no output schema. The description explains the return value as complete C# code snippets and gives example task categories, which is largely sufficient. Minor gaps remain around exact return structure and any limitations on scenario coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the scenario parameter already enumerates all available scenario names with parenthetical explanations. The description mentions task examples such as video capture and RTSP streaming, but adds no syntax, format, or selection guidance beyond what the schema already provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: get a code example for a VisioForge SDK scenario. It also clarifies that the output is complete, working C# snippets for tasks like video capture, RTSP streaming, and media playback. It is clear what the tool does, but it does not explicitly differentiate itself from siblings such as get_pipeline_template or get_method_signature.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by 'for a common VisioForge SDK scenario' and the listed task examples. However, there is no explicit guidance on when to use this tool versus alternatives like get_class_info, get_method_signature, or get_pipeline_template, and no exclusions are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources