Skip to main content
Glama
bharosa-docs-mcp

bharosa-docs-mcp

by bhafin

Search Bharosa API Documentation

bharosa_api_search
Read-onlyIdempotent

Search bundled API reference documents by query and optional HTTP method to retrieve documentation for integration planning; reads only a local index and never sends live API requests or accesses accounts.

Instructions

Search bundled API reference documents. Every result is documentation text, including references describing write endpoints. The optional method filter matches a documented HTTP verb; it does not send a request or select an action to execute. This tool only reads a local index and can never read or write an account.

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": {
      "query": "<query>"
    },
    "name": "bharosa_api_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
groupNo
limitNo
queryYesRequired nonblank literal search text, even when using group or method filters. For monthly API references, try query nav with group monthly. Maximum 120 raw characters.
methodNoFilter reference documents by their documented HTTP verb. Never executes that method or any network request.

Output Schema

NameRequiredDescriptionDefault
totalYes
noticeYes
matchesYes
reviewedOnYes
sdkVersionYes
availabilityYes
codingSha256Yes
bundleVersionYes
codingVersionYes
checkpointDateYes
contractVersionYes
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. Changed5 schema fields changedv0.3.2
    • addedInput schema / properties / method / description
      Added value: +"Filter reference documents by their documented HTTP verb. Never executes that method or any network request."
    • addedInput schema / properties / query / description
      Added value: +"Required nonblank literal search text, even when using group or method filters. For monthly API references, try query nav with group monthly. Maximum 120 raw characters."
    • 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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, and destructiveHint=false. The description reinforces this with 'only reads a local index and can never read or write an account' and clarifies the method filter matches documentation rather than executing a request, which is genuinely useful context about how the verb is interpreted. It restates the read-only profile rather than adding much beyond it, and repeats the no-request point twice.

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?

Front-loads what is searched and the safety guarantee, and each sentence targets a real concern. The no-request/no-execution idea is stated twice ('does not send a request or select an action to execute' and 'only reads a local index'), which is mild redundancy.

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 and annotations cover the safety profile, so the description fills the main gaps: result type (documentation text) and the non-executable semantics of the method filter. The meaning of the 'group' values and 'limit' behavior remain unexplained, a minor omission for a four-parameter read tool.

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 coverage is 50%, and the description compensates meaningfully by explaining that 'method' filters documented verbs rather than issuing requests. It adds nothing for 'group' or 'limit', whose enum and default/max bounds exist in schema but lack prose.

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: searching bundled API reference documents. It distinguishes itself from executing an API but never names the sibling tools (bharosa_docs_search, bharosa_examples_search) that an agent would need to compare against.

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?

Implies usage through 'Search bundled API reference documents' and mentions the method filter's purpose, but gives no explicit when-to-use vs when-to-use-a-sibling guidance (e.g., docs vs examples vs details). The only concrete hint ('try query nav with group monthly') sits in the schema, not the description.

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