Skip to main content
Glama
Sign In
cudaq-docs-mcp

cudaq-docs-mcp

by rogerawong
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_page

Fetch a CUDA-Q documentation page as clean markdown by its path, with optional version to match your installed package.

Instructions

Fetch one documentation page as clean markdown.

Args: path: Page path as returned by search_docs, for example "using/quick_start" or "using/backends/sims/svsims". version: Docs version. Defaults to the installed cudaq version.

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_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
versionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.2/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 burden. It discloses the output format ('clean markdown') and default version, but does not mention error behavior, permissions, or read-only status.

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 concise and front-loaded: a one-sentence summary followed by a clear Args block with examples. Every sentence earns 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 simple fetch tool, the description covers purpose, parameters, and return format. It lacks error handling or edge-case details, but is sufficient for typical use.

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

Parameters4/5

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

Schema coverage is 0%, but the description explains both parameters in detail, including examples for the path and the default behavior for version, adding significant meaning beyond the raw schema.

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?

The description clearly states 'Fetch one documentation page as clean markdown', with a specific verb and resource, and it distinguishes itself from sibling tools like search_docs or find_api.

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

Usage Guidelines4/5

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

It does not explicitly say when to use this tool vs alternatives, but it provides clear context by mentioning the path comes from search_docs and the version defaults to the installed cudaq version, implying a workflow.

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

Deploy Server

Other Tools