Skip to main content
Glama
bhafin

bharosa-docs-mcp

by bhafin

List Bharosa Documentation

bharosa_docs_list
Read-onlyIdempotent

List bundled Bharosa public documentation by offset and limit to page through available docs for integration planning. Use it to discover doc indexes without filesystem or network access.

Instructions

List bundled public documentation. Offset is a document index; at most 20 results. No filesystem or network access from arguments.

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo

Output Schema

NameRequiredDescriptionDefault
totalYes
noticeYes
documentsYes
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.2
    • changedOutput schema / properties / bundleVersion / const
      Previous value: -"0.2.0-docs.1"New value: +"0.3.2-docs.1"
    • changedOutput schema / properties / documents / items / 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"
      +]
  2. 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 establish that this is a read-only, idempotent, non-destructive, closed-world operation. The description adds useful behavioral context beyond that by noting the 20-result cap and that arguments do not grant filesystem or network access.

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 three short sentences with the purpose front-loaded. Each sentence adds useful information without repetition or filler.

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?

For a simple two-parameter read-only list tool with annotations and an output schema, the description is mostly complete. The main remaining gap is that limit semantics and sibling routing are not spelled out.

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 more weight. It explains offset as a document index and notes a 20-result maximum, but it does not explain the limit parameter's meaning or default, leaving part of the parameter semantics unaddressed.

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?

The description states a clear verb and resource: list bundled public documentation. It is distinguishable from the search/read siblings by the word 'List,' but it does not explicitly name or compare itself to those alternatives.

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: use this tool to browse bundled documentation. However, there is no explicit guidance on when to prefer it over bharosa_docs_search or bharosa_docs_read, and no exclusions are given.

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