bharosa-docs-mcp

Read Bharosa Documentation

bharosa_docs_read

Read-onlyIdempotent

Reads bundled Bharosa documentation by an allowlisted ID from bharosa_docs_list, using offset and maxChars to page through content without path or URL input.

Instructions

Read bundled documentation by its allowlisted ID from bharosa_docs_list. Offset and maxChars count UTF-16 code units; at most 8000 per response. No path or URL input.

Input Schema

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

Output Schema

Name	Required	Description	Default
`notice`	Yes
`offset`	Yes
`content`	Yes
`document`	Yes
`nextOffset`	Yes
`reviewedOn`	Yes
`availability`	Yes
`bundleVersion`	Yes
`checkpointDate`	Yes
`contractVersion`	Yes
`contractSourcePath`	Yes
`contractSourceSha256`	Yes
`publicContractSha256`	Yes
`publicContractVersion`	Yes
`approvedManifestSha256`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 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 / document / properties / sourcePath / enum

Previous value: -[
-  "marketing/src/content/guides.ts",
-  "marketing/contracts/openapi.json"
-]New value: +[
+  "marketing/src/content/guides.ts",
+  "marketing/src/content/analytics-guides.ts",
+  "sdk/test/openapi.json",
+  "sdk/test/analytics.openapi.json",
+  "sdk/test/market-search.openapi.json",
+  "marketing/src/content/consent-guide.ts"
+]

First observedv0.2.0Oct 27, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already cover safety (readOnlyHint, idempotentHint, openWorldHint=false, destructiveHint=false), so the bar is lower. The description adds real behavioral context beyond them: paging is in UTF-16 code units and a single response is capped at 8000, which tells the agent to expect chunked reads and loop. It does not say how truncation/continuation is signalled, which is the one remaining behavioral gap.

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 compact sentences, front-loaded with the core action and prerequisite, then the unit/size caveat, then the negative constraint. Every clause adds information the agent does not already have from structured fields.

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 values need not be explained, and annotations cover the safety profile. For a paginated read tool the only substantive omission is guidance on detecting truncation and advancing offset, but the unit and cap statements make correct paging largely inferable.

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 description coverage is 0%, so the description must carry the load, and it does for the two ambiguous params: offset and maxChars are declared to count UTF-16 code units with an 8000 ceiling. The id param's meaning is conveyed by "allowlisted ID from bharosa_docs_list" rather than the schema's regex pattern. Missing are defaults and failure behavior for a non-allowlisted ID.

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?

States a specific verb and resource ("Read bundled documentation") and pins the access key to an allowlisted ID sourced from bharosa_docs_list, which cleanly separates it from the search-style siblings. An agent can tell this is ID-based retrieval, not search, without opening any schema.

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?

Explicitly directs the agent to bharosa_docs_list to obtain a valid ID and closes off a likely wrong usage ("No path or URL input"). It stops short of naming bharosa_docs_search as the alternative for when the agent has a query rather than an ID, so the routing is clear but not fully enumerated.

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

Deploy Server