Skip to main content
Glama
bharosa-docs-mcp

bharosa-docs-mcp

by bhafin

Read Bharosa Documentation

bharosa_docs_read
Read-onlyIdempotent

Reads bundled Bharosa documentation by an allowlisted ID returned from the docs list, using offset and character limits for controlled paginated retrieval.

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.

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_docs_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
offsetNo
maxCharsNo

Output Schema

NameRequiredDescriptionDefault
noticeYes
offsetYes
contentYes
documentYes
nextOffsetYes
reviewedOnYes
availabilityYes
bundleVersionYes
checkpointDateYes
contractVersionYes
contractSourcePathYes
contractSourceSha256Yes
publicContractSha256Yes
publicContractVersionYes
approvedManifestSha256Yes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 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 / document / properties / sourcePath / enum
      Previous value: -[
      -  "marketing/src/content/guides.ts",
      -  "marketing/src/content/analytics-guides.ts",
      -  "marketing/src/content/benchmark-guide.ts",
      -  "sdk/test/openapi.json",
      -  "sdk/test/analytics.openapi.json",
      -  "sdk/test/market-search.openapi.json",
      -  "sdk/test/baseline-market.openapi.json",
      -  "sdk/test/fund-aum.openapi.json",
      -  "sdk/test/benchmarks.openapi.json",
      -  "marketing/src/content/consent-guide.ts"
      -]New value: +[
      +  "marketing/src/content/guides.ts",
      +  "marketing/src/content/analytics-guides.ts",
      +  "marketing/src/content/benchmark-guide.ts",
      +  "sdk/test/openapi.json",
      +  "sdk/test/analytics.openapi.json",
      +  "sdk/test/market-search.openapi.json",
      +  "sdk/test/baseline-market.openapi.json",
      +  "sdk/test/fund-aum.openapi.json",
      +  "sdk/test/benchmarks.openapi.json",
      +  "sdk/test/catalog.openapi.json",
      +  "marketing/src/content/catalog-v010.ts",
      +  "marketing/src/content/consent-guide.ts"
      +]
  2. Changed2 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 / document / properties / sourcePath / enum
      Previous 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"
      -]New value: +[
      +  "marketing/src/content/guides.ts",
      +  "marketing/src/content/analytics-guides.ts",
      +  "marketing/src/content/benchmark-guide.ts",
      +  "sdk/test/openapi.json",
      +  "sdk/test/analytics.openapi.json",
      +  "sdk/test/market-search.openapi.json",
      +  "sdk/test/baseline-market.openapi.json",
      +  "sdk/test/fund-aum.openapi.json",
      +  "sdk/test/benchmarks.openapi.json",
      +  "marketing/src/content/consent-guide.ts"
      +]
  3. Changed2 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 / 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"
      +]
  4. First observedv0.2.0

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds genuinely useful behavior: UTF-16 code-unit counting, an 8000-character response cap, and the absence of path/URL input. It stops short of describing what happens when offset exceeds document length or how truncation is signaled.

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 short sentences, front-loaded with the core action and the ID constraint, then pagination semantics. No filler or restatement of the title.

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 no explanation, and pagination plus the response cap are covered. Minor gaps remain around boundary behavior (offset beyond end, truncation indication) for a tool whose only real complexity is paging.

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 explain the unit semantics of offset/maxChars and the origin of id. It omits the offset ceiling of 30000 and the defaults, leaving some schema constraints unexplained in prose.

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 identifier source to bharosa_docs_list, which cleanly separates it from the search/list siblings. An agent can identify the tool's role without opening the 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 constrains input to an allowlisted ID obtained from bharosa_docs_list, which is a real usage prerequisite. It does not name when to prefer bharosa_examples_read or bharosa_docs_search instead, so the routing guidance is clear but not exhaustive.

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