ROKI Connect

Get a ROKI Connect schema

roki_get_schema

Read-onlyIdempotent

Return a fully dereferenced JSON Schema by name (e.g. "PaymentCreateRequest", "Payment", "WebhookEvent"). Use it to know the exact field names, types and constraints.

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": "roki_get_schema"
  }
}

Input Schema

Name	Required	Description	Default
`name`	No	Schema name. Omit to list all available schemas.

Schema Changelog

Changes observed during successful MCP inspections.

First observedAug 17, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds value by explaining 'fully dereferenced' (indicating resolved references) and the optional listing behavior when 'name' is omitted. This goes beyond annotations without contradicting them.

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?

Two sentences, front-loaded with the primary action, and packed with useful examples and behavioral notes. No filler words or redundant information.

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?

Despite having no output schema, the description explains what is returned (a fully dereferenced JSON Schema), how to use it, and when to use it. For a simple lookup tool with one optional parameter, this is complete.

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 100% (the 'name' parameter has a description). The tool description enhances this by giving concrete example values (PaymentCreateRequest, Payment, WebhookEvent) and clarifying that omitting the parameter lists all schemas, aligning with the schema's note.

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?

Description starts with a specific action ('Return a fully dereferenced JSON Schema'), names the resource ('JSON Schema'), and clarifies the scope ('by name'). Examples of valid schema names make it clear what the tool is for and distinguish it from sibling tools like roki_get_operation or roki_get_doc_section.

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?

States a clear use case: 'Use it to know the exact field names, types and constraints.' This tells the agent when to choose it. It doesn't explicitly list alternatives or exclusions, but given the tool's narrow scope, the context is sufficient.

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

All ROKI Connect tools Inspect

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

Need Help?