Skip to content

docs(crewai-tools): fix MCP connection typo#5792

Open
otjdiepluong wants to merge 1 commit into
crewAIInc:mainfrom
otjdiepluong:docs/fix-duplicated-the-in-crewai-tools-readme
Open

docs(crewai-tools): fix MCP connection typo#5792
otjdiepluong wants to merge 1 commit into
crewAIInc:mainfrom
otjdiepluong:docs/fix-duplicated-the-in-crewai-tools-readme

Conversation

@otjdiepluong
Copy link
Copy Markdown

@otjdiepluong otjdiepluong commented May 13, 2026

Fixes a duplicated word in the CrewAI tools MCP README section.

Docs-only change; no tests needed.

AI assistance: Kimi CLI was used for the single-line edit; reviewed before submission.

Summary by CodeRabbit

  • Documentation
    • Corrected grammar in MCP documentation and clarified the connection lifecycle behavior for the "Fully managed connection" option.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

📝 Walkthrough

Walkthrough

A single line in the MCP documentation was updated to correct a duplicate word and clarify the role of the with statement in managing the MCP server connection lifecycle.

Changes

MCP Context Manager Documentation Clarification

Layer / File(s) Summary
MCP context manager documentation clarification
lib/crewai-tools/README.md
Removed duplicated word "the" and clarified that the with statement starts and stops the connection to the MCP server.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

🐰 A word doubled over, now made clear,
Context managers guide the connection near,
With starts and stops in prose refined,
Documentation reads with clearer mind!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(crewai-tools): fix MCP connection typo' accurately reflects the main change: fixing a typo (duplicated word) in the documentation.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@otjdiepluong
Copy link
Copy Markdown
Author

AI assistance disclosure: Kimi CLI was used for the single-line documentation edit, and I reviewed the change before submitting. The repository requires the llm-generated label for AI-assisted PRs, but my account does not have permission to add labels; maintainers, please add llm-generated.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@lib/crewai-tools/README.md`:
- Line 86: The README wording uses the fused term "contextmanager" — update the
prose to the standard two-word phrase "context manager" where it describes the
`with` statement (e.g., change "contextmanager (`with` statement)" to "context
manager (`with` statement)") so the documentation reads correctly; search for
occurrences in lib/crewai-tools/README.md and replace accordingly, preserving
the inline code formatting around `with`.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: af8c00b8-5c04-4316-ab68-3e99158c8e67

📥 Commits

Reviewing files that changed from the base of the PR and between c36827b and f078dd4.

📒 Files selected for processing (1)
  • lib/crewai-tools/README.md

### Option 1: Fully managed connection

In this scenario we use a contextmanager (`with` statement) to start and stop the the connection with the MCP server.
In this scenario we use a contextmanager (`with` statement) to start and stop the connection with the MCP server.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use “context manager” (two words) in docs prose.

Small wording tweak for correctness/readability: “context manager” is the standard term in narrative text.

Suggested edit
-In this scenario we use a contextmanager (`with` statement) to start and stop the connection with the MCP server.
+In this scenario, we use a context manager (`with` statement) to start and stop the connection with the MCP server.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
In this scenario we use a contextmanager (`with` statement) to start and stop the connection with the MCP server.
In this scenario, we use a context manager (`with` statement) to start and stop the connection with the MCP server.
🤖 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 `@lib/crewai-tools/README.md` at line 86, The README wording uses the fused
term "contextmanager" — update the prose to the standard two-word phrase
"context manager" where it describes the `with` statement (e.g., change
"contextmanager (`with` statement)" to "context manager (`with` statement)") so
the documentation reads correctly; search for occurrences in
lib/crewai-tools/README.md and replace accordingly, preserving the inline code
formatting around `with`.

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