Skip to main content
Glama
bharosa-docs-mcp

bharosa-docs-mcp

by bhafin

Read Bharosa Code Example

bharosa_examples_read
Read-onlyIdempotent

Read a canonical Bharosa example by allowlisted ID, including optional initialization context and source hash, with UTF-16 offset limits. Returns text only and never executes code.

Instructions

Read a canonical example by allowlisted ID, its optional initialization context and source hash. UTF-16 offsets; at most 8000 code units. Returns text only; never executes code.

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": {
      "id": "<id>"
    },
    "name": "bharosa_examples_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
offsetNo
maxCharsNo

Output Schema

NameRequiredDescriptionDefault
codeYes
setupYes
noticeYes
offsetYes
exampleYes
nextOffsetYes
reviewedOnYes
sdkVersionYes
availabilityYes
codingSha256Yes
bundleVersionYes
codingVersionYes
checkpointDateYes
contractVersionYes
contractSourcePathYes
contractSourceSha256Yes
publicContractSha256Yes
publicContractVersionYes
approvedManifestSha256Yes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.3.7
    • changedOutput schema / properties / bundleVersion / const
      Previous value: -"0.3.6-docs.1"New value: +"0.3.7-docs.1"
    • changedOutput schema / properties / codingVersion / const
      Previous value: -"0.3.6-coding.1"New value: +"0.3.7-coding.1"
    • changedOutput schema / properties / example / properties / sdkVersion / const
      Previous value: -"0.9.0"New value: +"0.10.0"
    • changedOutput schema / properties / sdkVersion / const
      Previous value: -"0.9.0"New value: +"0.10.0"
  2. Changed4 schema fields changedv0.3.6
    • changedOutput schema / properties / bundleVersion / const
      Previous value: -"0.3.2-docs.1"New value: +"0.3.6-docs.1"
    • changedOutput schema / properties / codingVersion / const
      Previous value: -"0.3.2-coding.1"New value: +"0.3.6-coding.1"
    • changedOutput schema / properties / example / properties / sdkVersion / const
      Previous value: -"0.6.0"New value: +"0.9.0"
    • changedOutput schema / properties / sdkVersion / const
      Previous value: -"0.6.0"New value: +"0.9.0"
  3. Changed6 schema fields changedv0.3.2
    • changedOutput schema / properties / bundleVersion / const
      Previous value: -"0.2.0-docs.1"New value: +"0.3.2-docs.1"
    • changedOutput schema / properties / codingVersion / const
      Previous value: -"0.2.0-coding.1"New value: +"0.3.2-coding.1"
    • changedOutput schema / properties / example / properties / language / enum
      Previous value: -[
      -  "typescript",
      -  "bash",
      -  "json"
      -]New value: +[
      +  "typescript",
      +  "javascript",
      +  "bash",
      +  "json"
      +]
    • changedOutput schema / properties / example / properties / sdkVersion / const
      Previous value: -"0.1.0"New value: +"0.6.0"
    • changedOutput schema / properties / example / properties / validation / enum
      Previous value: -[
      -  "strict-typescript-and-synthetic-transport",
      -  "strict-typescript",
      -  "shell-syntax-only",
      -  "json-parse"
      -]New value: +[
      +  "strict-typescript-and-synthetic-transport",
      +  "strict-typescript",
      +  "shell-syntax-only",
      +  "javascript-syntax-only",
      +  "json-parse"
      +]
    • changedOutput schema / properties / sdkVersion / const
      Previous value: -"0.1.0"New value: +"0.6.0"
  4. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety bar is low; the description still adds real value by disclosing offset semantics (UTF-16 code units), the 8000-code-unit ceiling, and that it returns text without executing code. It doesn't mention truncation signaling or what the source hash is used to verify, which would have made it a 5.

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?

Three tight clauses with the action, its selector, and the paging/return constraints front-loaded; zero filler and nothing repeated from the annotations.

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?

An output schema exists, so return shape needn't be described, and the description still names the payload pieces (example text, init context, source hash). For a small read-only tool with three parameters this is nearly complete; only the truncation/continuation behavior when the 8000-unit cap is hit is left unstated.

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 0%, so the description must carry the load: it explains the ID is allowlisted, that offsets are UTF-16 code units, and that reads cap at 8000 code units — covering all three parameters at a high level. However it omits the maxChars default of 4000, that maxChars is itself a count of code units, and any hint about the ID pattern restriction, so half the schema's constraints remain unexplained.

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?

States a specific verb and resource — read a canonical example by allowlisted ID — plus what comes back (initialization context and source hash). It implicitly contrasts with a search-by-query sibling via 'by allowlisted ID', but never names that alternative, so the differentiation is inferred rather than explicit.

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

Usage Guidelines3/5

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

'by allowlisted ID' hints that an ID must be obtained elsewhere (presumably bharosa_examples_search), but the description never says so, nor does it state when to prefer this over reading docs. Usage is implied by the required parameter rather than spelled out.

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