bharosa-docs-mcp

Search Bharosa Documentation

bharosa_docs_search

Read-onlyIdempotent

Search bundled Bharosa documentation by ID, title, or text using case-insensitive literal terms. Returns ranked matches to help coding agents find contracts, API details, and SDK examples for integration planning.

Instructions

Search bundled IDs, titles and text using case-insensitive literal AND terms, ranked by exact ID/title and title matches with source-order ties. At most 120 query characters and 20 results; no regex or remote search.

Input Schema

Name	Required	Description	Default
`limit`	No
`query`	Yes

Output Schema

Name	Required	Description	Default
`total`	Yes
`notice`	Yes
`matches`	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 / matches / 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"
+]

First observedv0.2.0Oct 27, 2026

TDQS

A4/5.0

Behavior5/5

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

Annotations already establish that the operation is read-only, idempotent, local, and non-destructive. Beyond that, the description discloses matching behavior (case-insensitive literal AND terms), ranking rules (exact ID/title and title matches with source-order ties), and operational limits (120 query characters, 20 results, no regex or remote search).

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 two dense sentences with no wasted text, and it front-loads the core action before adding matching, ranking, and limit details. Every clause contributes operational value.

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 value details are not required in the description. The description covers the search mechanism and constraints sufficiently for invocation, though it could more explicitly clarify the relationship to sibling read/list/search tools.

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 parameter meaning. It explains the query semantics and maximum query length well, and mentions the 20-result cap, but it does not explain the adjustable limit parameter or its default of 5.

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 uses a specific verb and resource: search bundled documentation IDs, titles, and text. It is clear what is searched, though it does not explicitly distinguish this from sibling searches such as bharosa_api_search or bharosa_examples_search.

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?

The description implies usage for literal term searches and rules out regex or remote search, which is useful constraint information. However, it does not say when to choose this over bharosa_docs_list, bharosa_docs_read, or the other search tools.

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

Deploy Server