brc_get_help_resource_details
Load full help-resource details for a resourceId returned by brc_red_help or brc_find_help_resources. For Big Red Cloud how-to or tutorial questions, call this automatically for the best matching Freshdesk article with includeImages=true and imagePresentation=links — even when the user did not ex...
This record as markdown: /tools/io-github-bigredcloud-red-mcp-server/brc-get-help-resource-details.md
What brc_get_help_resource_details does on Red by Big Red Cloud
AI agents call brc_get_help_resource_details to retrieve information from Red by Big Red Cloud without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
question | string | — | Optional customer question used to select the matching Freshdesk workflow screenshots, for example an existing-customer opening balance question versus adding a |
maxImages | integer | — | Maximum Freshdesk screenshots to return. Defaults to 5. Hard maximum 8. |
resourceId | string | Yes | Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001. |
includeImages | boolean | — | When true, Freshdesk articles may include screenshot presentation. Defaults to true. |
imagePresentation | string | — | How to present Freshdesk screenshots. Defaults to links (signed Markdown links only). Use inline for MCP image blocks, or both for Markdown plus image blocks. |
Parameters from the server's own tool schema.
Why brc_get_help_resource_details is rated Low
Even though brc_get_help_resource_details only reads data, uncontrolled read access leaks sensitive information and racks up API costs: an agent caught in a retry loop can make thousands of calls a minute without anyone noticing.
Risk signalsBulk/mass operation — affects multiple targets
Attacks that exploit this kind of access
The rule that runs brc_get_help_resource_details safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Red by Big Red Cloud, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For brc_get_help_resource_details, this is the rule to start with:
brc_get_help_resource_details is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Red by Big Red Cloud, apply this rule, and every brc_get_help_resource_details call is checked against it from then on.
Questions about brc_get_help_resource_details
Load full help-resource details for a resourceId returned by brc_red_help or brc_find_help_resources. For Big Red Cloud how-to or tutorial questions, call this automatically for the best matching Freshdesk article with includeImages=true and imagePresentation=links — even when the user did not explicitly ask for screenshots. Freshdesk resources return cleaned article text, the canonical Freshdesk publicUrl when available, preferred instructionBlocks, ready-to-use customerFacingScreenshotMarkdown / customerFacingInstructionMarkdown, screenshotUrls for backward compatibility, Sources fields, optional Red-action fields, and optional MCP image content. When includeImages is true, use imagePresentation='links' unless the user explicitly asks for inline image content. Copy the exact Markdown links returned in customerFacingScreenshotMarkdown or customerFacingInstructionMarkdown into the final answer. Place each link after its related step. Use the short View image link text (or View image N when one step has multiple images) — do not paste the descriptive caption as link text or as a second instruction sentence. Never omit valid returned screenshot links after telling the user screenshots are available. Do not merely describe the screenshots. Do not say Here are the screenshots without including the links. Do not replace links with Screenshot 1, Tool result, Show Image, or invent different URLs. Do not depend on tool-result image previews being visible to the user — the final answer must contain the exact signed Markdown links. If no links are returned, clearly say that no matching screenshot was found. Pass the customer question when available so Freshdesk screenshots are selected from the matching workflow branch (for example existing customer versus add customer). Prefer instructionBlocks / customerFacingInstructionMarkdown when present: follow them in order and keep every screenshot Markdown link exact. Never label screenshot links Show Image. Do not invent captions or URLs. Do not group screenshots under a Relevant screenshots section when step-and-link Markdown is available. Omit screenshots from unused workflow branches. Omit unclear screenshots rather than guessing. Do not repeat a screenshot. When instructionBlocks are absent, use customerFacingScreenshotMarkdown with [View image](URL) links and place each after the most relevant paragraph where possible. Do not rewrite or alter supplied screenshot URLs. Copy customerFacingSourcesMarkdown into a Sources section using the exact publicUrl or registrationUrl returned by this tool. Group Freshdesk / documentation under Articles and recorded webinars under Videos — omit an empty Videos heading. Keep screenshot links beside steps — do not move them into Sources. When redActionAvailable is true, include customerFacingRedActionMarkdown after Sources. Do not start the Red action unless the user asks. Mention preview-before-posting for write actions. Always end with customerFacingSupportMarkdown (Still need help?) after Sources and any Red-action section. Freshdesk links use bigredcloud.freshdesk.com — never rewrite them onto bigredcloud.com/support. Customer documentation returns cleaned article text and the public docs URL. Recorded webinars return title, description, public video URL, and category. Upcoming webinars return title, weekday, description, topics, registration URL, and webinar-series page URL. Read-only. Does not require a connected company. MCP image content blocks are optional compatibility content when imagePresentation is inline or both. Do not claim screenshots were supplied when imageCount is 0 or when no Markdown links are returned. Do not expose Azure blob names, storage URLs, private Freshdesk image URLs, image hashes, or sync metadata in customer-facing text. Never claim company data was changed by a tutorial answer. It is categorised as a Read tool in the Red by Big Red Cloud MCP Server, which means it retrieves data without modifying state.
brc_get_help_resource_details accepts 5 parameters: question, maxImages, resourceId, includeImages, imagePresentation. Required: resourceId. The full parameter table on this page comes from the server's own tool schema.
Register the Red by Big Red Cloud MCP server in PolicyLayer and add a rule for brc_get_help_resource_details: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Red by Big Red Cloud. Nothing to install.
brc_get_help_resource_details is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the brc_get_help_resource_details rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for brc_get_help_resource_details. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
brc_get_help_resource_details is provided by the Red by Big Red Cloud MCP server (https://red.bigredcloud.com/mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Red by Big Red Cloud, and thousands of servers like it.
This server
Across the catalogue