Skip to content

Document Bomly MCP server#229

Merged
bomly-guy merged 6 commits into
mainfrom
codex/document-mcp-server
Jul 6, 2026
Merged

Document Bomly MCP server#229
bomly-guy merged 6 commits into
mainfrom
codex/document-mcp-server

Conversation

@bomly-guy

@bomly-guy bomly-guy commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a dedicated public MCP server guide for Bomly CLI and wires it into the existing docs navigation.

Changes

  • Add docs/MCP.md with setup snippets for Claude Code, Cursor, and VS Code.
  • Document the five exposed MCP tools, their arguments, and enrichment behavior.
  • Clarify local stdio server behavior, security/network expectations, and common troubleshooting paths.
  • Link the guide from the README, Getting Started, docs index, and docs manifest.

Validation

  • go run ./cmd/bomly mcp serve --help
  • go test ./internal/mcp ./internal/cli -run 'Mcp|MCP'
  • git diff --check
  • make test

Note: the first make test run hit transient Java readiness timeouts in Gradle/Maven/sbt detector tests. The affected packages passed when rerun directly, and the full make test rerun passed.

Summary by CodeRabbit

  • Documentation
    • Added a new guide for using Bomly as a local MCP server with AI agents.
    • Expanded setup instructions with example commands and guidance for common MCP clients.
    • Updated the getting-started and docs index pages to link to the new MCP server documentation.
    • Refined AI-agent guidance to better reflect available local capabilities.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@bomly-guy, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 22 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 44f4dccd-1523-4463-be20-b2c83cecadf7

📥 Commits

Reviewing files that changed from the base of the PR and between 9f9ed52 and a1e777b.

📒 Files selected for processing (3)
  • docs/MCP.md
  • docs/README.md
  • docs/manifest.json
📝 Walkthrough

Walkthrough

This PR adds a new documentation file, docs/MCP.md, describing how to run Bomly as a local MCP server (setup, tools, security, troubleshooting), and updates README.md, docs/GETTING_STARTED.md, docs/README.md, and docs/manifest.json to link to and reference this new guide.

Changes

MCP Server Documentation

Layer / File(s) Summary
New MCP server guide
docs/MCP.md
Adds full documentation for running Bomly as a local stdio MCP server, including prerequisites, client setup for Claude Code/Cursor/VS Code, the five registered tools, example prompts, security/network behavior, and troubleshooting.
Cross-doc references and index updates
README.md, docs/GETTING_STARTED.md, docs/README.md, docs/manifest.json
Updates the "Use Bomly With AI Agents" sections and documentation indexes to link to docs/MCP.md and adds a manifest entry for the MCP server page.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • bomly-dev/bomly-cli#160: Both PRs modify the "Use Bomly With AI Agents"/MCP server documentation in README.md describing running Bomly as a local MCP server.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding Bomly MCP server documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/document-mcp-server

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Bomly Diff Summary

Compared 0c24d4537997e6872657600fed97704ed890800c to a1e777bdca9a532a7213599a64b918c05440de35.

Overview

Status Manifests Dependencies Findings Duration
✅ Pass +0 / ~0 / -0 +0 / ~0 / -0 0 introduced / 0 persisted / 0 resolved 1m 5s

Dependency Changes

✅ No dependency changes.

Vulnerabilities

✅ No vulnerability changes.

License Changes

✅ No license changes.

Project Posture

✅ No project posture changes (--matchers +scorecard was not selected).

Policy Findings

✅ No policy differences were identified.

@bomly-guy bomly-guy marked this pull request as ready for review July 5, 2026 23:20

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/MCP.md (1)

92-105: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add an explicit ecosystem-coverage note.

The page covers setup, semantics, output shape, and limitations, but it never states which ecosystems the MCP server covers. The docs guideline for docs/**/*.md asks for explicit ecosystem coverage; a short note linking to SUPPORT_MATRIX.md or saying it matches the CLI would close that gap.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/MCP.md` around lines 92 - 105, The MCP tools section in MCP.md is
missing an explicit ecosystem-coverage note. Add a short statement near the tool
table or response-shape summary that says which ecosystems Bomly’s MCP server
supports, and reference SUPPORT_MATRIX.md or note that it matches the CLI
coverage. Use the existing tool names like bomly_scan, bomly_explain, and
bomly_diff to place the note alongside the documented capabilities.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/MCP.md`:
- Around line 98-100: The MCP docs are advertising the unsupported `container`
alias for `bomly_scan` and `bomly_diff`, which does not match the actual server
surface. Update the tool-argument tables in `docs/MCP.md` to reflect the real
inputs exposed by `internal/mcp/server.go` for `bomly_scan`, `bomly_explain`,
and `bomly_diff`, and remove `container` from the documented accepted
parameters.

---

Nitpick comments:
In `@docs/MCP.md`:
- Around line 92-105: The MCP tools section in MCP.md is missing an explicit
ecosystem-coverage note. Add a short statement near the tool table or
response-shape summary that says which ecosystems Bomly’s MCP server supports,
and reference SUPPORT_MATRIX.md or note that it matches the CLI coverage. Use
the existing tool names like bomly_scan, bomly_explain, and bomly_diff to place
the note alongside the documented capabilities.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 82d5879d-e244-4daa-8f2c-72313294dbc1

📥 Commits

Reviewing files that changed from the base of the PR and between 0c24d45 and 9f9ed52.

📒 Files selected for processing (5)
  • README.md
  • docs/GETTING_STARTED.md
  • docs/MCP.md
  • docs/README.md
  • docs/manifest.json

Comment thread docs/MCP.md Outdated
Comment thread docs/README.md Outdated
@bomly-guy bomly-guy merged commit b49bb88 into main Jul 6, 2026
13 checks passed
@bomly-guy bomly-guy deleted the codex/document-mcp-server branch July 6, 2026 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant