Skip to main content
Glama

Read a Synento guide

get_guide
Read-onlyIdempotent

Read a Synento guide. Available: index, getting-started, guides/mcp, concepts, api-reference, browser-support, guides/access-control, guides/cli, guides/json2video-clips, guides/recordings-replay, guides/sdk, guides/sessions, guides/webhooks, examples/cli-examples, examples/sdk-advanced, examples/sdk-basic, examples/web-quickstart. (Requires scope mcp:read.)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / enum
      Previous value: -[
      -  "index",
      -  "getting-started",
      -  "guides/mcp",
      -  "concepts",
      -  "api-reference",
      -  "browser-support",
      -  "guides/access-control",
      -  "guides/cli",
      -  "guides/recordings-replay",
      -  "guides/sdk",
      -  "guides/sessions",
      -  "guides/webhooks",
      -  "examples/cli-examples",
      -  "examples/sdk-advanced",
      -  "examples/sdk-basic",
      -  "examples/web-quickstart"
      -]New value: +[
      +  "index",
      +  "getting-started",
      +  "guides/mcp",
      +  "concepts",
      +  "api-reference",
      +  "browser-support",
      +  "guides/access-control",
      +  "guides/cli",
      +  "guides/json2video-clips",
      +  "guides/recordings-replay",
      +  "guides/sdk",
      +  "guides/sessions",
      +  "guides/webhooks",
      +  "examples/cli-examples",
      +  "examples/sdk-advanced",
      +  "examples/sdk-basic",
      +  "examples/web-quickstart"
      +]
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive and closed-world, so the safety profile is covered. The description adds genuinely new behavioral context — the required `mcp:read` scope — which an agent cannot infer from structured fields, though it says nothing about the returned content's form or size.

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

Conciseness2/5

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

The purpose sentence is well front-loaded, but the majority of the text is a 17-item list copied directly from the schema enum, which an agent already receives. That bulk consumes attention without earning its place.

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?

For a single-enum, read-only documentation fetch with no output schema, the definition covers purpose, allowed inputs, and the auth requirement. The one remaining gap is that the format of the returned guide content is unstated, which is minor for a docs-reader tool.

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?

The single `path` parameter is fully constrained by an enum in the schema, so validity is already enforced. The description restates the enum verbatim without explaining what each guide covers, so it adds no meaning beyond the schema — pure duplication rather than semantic enrichment.

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

Purpose5/5

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

States a specific verb and resource ("Read a Synento guide") and names the product domain. The sibling tools are all project/session/account operations, so there is no ambiguity about which tool retrieves documentation content.

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?

The description enumerates the valid guide paths, which helps pick a value once the agent has decided to call it, but it never states when to reach for a guide (e.g., before using the MCP or SDK APIs) or what to do if a needed topic is not listed. Usage is implied rather than guided.

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