Skip to main content
Glama

Red by Big Red Cloud

by io.github.BigRedCloud
OverviewDiscussionsAdmin

Get Help Resource Details

brc_get_help_resource_details
Read-only

Returns detailed public help-resource content, ordered instruction blocks, signed screenshot links, source metadata and optional image content. Read-only and available without a connected company.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
questionNoOptional customer question used to select the matching Freshdesk workflow screenshots, for example an existing-customer opening balance question versus adding a new customer.
maxImagesNoMaximum Freshdesk screenshots to return. Defaults to 5. Hard maximum 8.
resourceIdYesResource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001.
includeImagesNoWhen true, Freshdesk articles may include screenshot presentation. Defaults to true.
imagePresentationNoHow to present Freshdesk screenshots. Defaults to links (signed Markdown links only). Use inline for MCP image blocks, or both for Markdown plus image blocks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / properties / connectionRef
      Removed value: -{
-  "description": "Opaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials.",
-  "type": "string"
-}
    • changedInput schema / properties / resourceId / description
      Previous value: -"Resource ID from brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."New value: +"Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."
  2. Changed2 schema fields changed
    • addedInput schema / properties / connectionRef
      Added value: +{
+  "description": "Opaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials.",
+  "type": "string"
+}
    • changedInput schema / properties / resourceId / description
      Previous value: -"Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."New value: +"Resource ID from brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."
  3. Changed2 schema fields changed
    • removedInput schema / properties / connectionRef
      Removed value: -{
-  "description": "Opaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials.",
-  "type": "string"
-}
    • changedInput schema / properties / resourceId / description
      Previous value: -"Resource ID from brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."New value: +"Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."
  4. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description reinforces this with 'Read-only'. It adds genuine behavioral context by noting the tool works without a connected company and that it returns signed screenshot links, ordered instruction blocks, source metadata, and optional image content.

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 short sentences with no filler. It front-loads the core purpose, then adds the key operating constraint (read-only, no connected company). Every part 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?

The description covers what the tool returns, its read-only nature, and its availability without a connected company. Since there is no output schema, listing the return categories helps the agent know what to expect; the parameter schema handles the remaining invocation details.

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%, so the schema already documents all five parameters clearly, including examples and defaults. The description contributes little additional parameter-level meaning beyond characterizing the general return content.

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 clearly states the operation ('Returns') and the specific resource ('detailed public help-resource content'), listing the kinds of data returned. It does not explicitly name sibling tools like brc_red_help or brc_find_help_resources, though the tool name and resourceId schema hint at the relationship.

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

Usage Guidelines2/5

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

The description gives some context ('available without a connected company') but does not explicitly say when to use this tool versus alternatives such as brc_red_help or brc_find_help_resources. The resourceId parameter description mentions those sibling tools, but the description itself lacks that routing guidance.

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

All Red by Big Red Cloud 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