bharosa-docs-mcp

Read Bharosa Code Example

bharosa_examples_read

Read-onlyIdempotent

Read a canonical Bharosa example by allowlisted ID, including optional initialization context and source hash, to support grounded integration planning; 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.

Input Schema

Name	Required	Description	Default
`id`	Yes
`offset`	No
`maxChars`	No

Output Schema

Name	Required	Description	Default
`code`	Yes
`setup`	Yes
`notice`	Yes
`offset`	Yes
`example`	Yes
`nextOffset`	Yes
`reviewedOn`	Yes
`sdkVersion`	Yes
`availability`	Yes
`codingSha256`	Yes
`bundleVersion`	Yes
`codingVersion`	Yes
`checkpointDate`	Yes
`contractVersion`	Yes
`contractSourcePath`	Yes
`contractSourceSha256`	Yes
`publicContractSha256`	Yes
`publicContractVersion`	Yes
`approvedManifestSha256`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv0.3.2Oct 31, 2026

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"
```

First observedv0.2.0Oct 27, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations already cover the read-only, idempotent, non-destructive, non-open-world safety profile. The description adds meaningful behavioral context beyond that: UTF-16 offsets, an 8000-code-unit cap, text-only output, and the fact that code is never executed.

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 two tight sentences, front-loads the core lookup action, and packs offset, size, and execution-safety constraints without unnecessary prose.

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 tool has rich annotations, an output schema, and only three parameters, so the description does not need to explain return values. It covers the key operational constraints, though it leaves the relationship to bharosa_examples_search and ID acquisition implicit.

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?

With 0% schema description coverage, the description must compensate for all three parameters. It explains that the ID is allowlisted, that offsets are in UTF-16 code units, and that output is capped at 8000 code units, but it does not fully explain offset starting-position semantics, maxChars defaults, or the relationship between the two pagination parameters.

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 states a specific verb and resource: read a canonical example. The phrase 'by allowlisted ID' distinguishes it from the sibling search tool and makes clear it is an ID-based lookup rather than a discovery operation.

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?

Usage is implied by 'by allowlisted ID', which tells the agent an ID is required, but the description does not explicitly say when to use this versus bharosa_examples_search or how to obtain a valid allowlisted ID.

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

Deploy Server