Skip to main content
Glama
Sign In

RideDesk Developer Docs

by app.ridedesk
OverviewDiscussionsAdmin

Get the integration brief

get_integration_brief
Read-only

A self-contained brief for a coding agent building a transfer-booking website on the RideDesk API — the flow, the rules the server enforces, and the acceptance criteria.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_integration_brief"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostNoThe operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already state readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context by explaining that the brief is self-contained and describing its contents, including the flow, rules, and acceptance criteria, which helps the agent know what to expect from the result.

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 a single, well-structured sentence that front-loads the tool's purpose and then adds the key content details. There is no wasted wording, repetition, or unnecessary background.

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

Completeness5/5

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

For a scope-constrained, read-only tool with one optional parameter and no output schema, the description is sufficiently complete. It tells the agent what this artifact is, who it is for, what it covers, and that it is self-contained. No critical guidance is missing.

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 schema already provides full 100% coverage for the single optional host parameter, including a clear example. The description adds no additional parameter-level meaning, which is acceptable since the schema fully carries that burden.

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 identifies the tool as returning a specific resource: a self-contained integration brief for building a transfer-booking website on the RideDesk API. It details what the brief contains (flow, server-enforced rules, acceptance criteria), making it distinguishable from generic sibling tools like get_doc or search_docs.

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?

The intended use context is clear: a coding agent building a transfer-booking website on the RideDesk API. It does not explicitly contrast this with get_doc, get_widget_snippets, list_docs, or search_docs, but the description makes it obvious when this brief is the relevant resource.

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

All RideDesk Developer Docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources