Skip to main content
Glama
bharosa-docs-mcp

bharosa-docs-mcp

by bhafin

Read Bharosa API Documentation

bharosa_api_details
Read-onlyIdempotent

Retrieve a single canonical API operation—method, path, parameters, request/response bodies, and source examples—to plan integrations without live calls or credentials.

Instructions

Read one canonical API operation: method, path, parameters, body/responses and available source examples. Follow schema document IDs for referenced definitions. No API execution or credentials.

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": {
      "operationId": "<operationId>"
    },
    "name": "bharosa_api_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
operationIdYes

Output Schema

NameRequiredDescriptionDefault
noticeYes
operationYes
exampleIdsYes
reviewedOnYes
sdkVersionYes
availabilityYes
codingSha256Yes
bundleVersionYes
codingVersionYes
checkpointDateYes
contractVersionYes
schemaDocumentIdsYes
contractSourcePathYes
contractSourceSha256Yes
publicContractSha256Yes
publicContractVersionYes
approvedManifestSha256Yes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 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 / sdkVersion / const
      Previous value: -"0.9.0"New value: +"0.10.0"
  2. Changed3 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 / sdkVersion / const
      Previous value: -"0.6.0"New value: +"0.9.0"
  3. Changed3 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 / sdkVersion / const
      Previous value: -"0.1.0"New value: +"0.6.0"
  4. First observedv0.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description adds genuinely new context: it performs no execution and needs no credentials, and its output is a documentation payload meant to be traversed via referenced document IDs. It does not mention pagination or size limits, but the read-only doc nature makes that minor.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with what is read, followed by the traversal hint and the execution/credentials caveat. No filler; the final fragment earns its place by pre-empting a wrong assumption about the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 the tool is a simple single-parameter read. Still, for a tool whose only input is an opaque identifier, the description leaves the caller without any way to know how to produce a valid operationId, which is essential for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single required parameter, operationId; the schema only supplies a regex pattern. The description never explains what an operationId is, where to obtain one (presumably from search results), or that it must be a canonical operation identifier rather than a path or free-text query. This is the definition's clearest gap and it is the only parameter.

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 one canonical API operation") and enumerates exactly what is returned: method, path, parameters, body/responses, source examples. The word "one" plus the singular scope implicitly separates it from the sibling search tools (bharosa_api_search, bharosa_examples_search), though no sibling is named explicitly.

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?

"Follow schema document IDs for referenced definitions" gives a clear next-step usage pattern, and "No API execution or credentials" sets a boundary. However, there is no explicit statement of when to call this versus bharosa_api_search or bharosa_examples_read, so the agent must infer the lookup flow.

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