Skip to content

docs(tools/search-research): add iFlow Search MCP (community)#5928

Open
zhengyanglsun wants to merge 3 commits into
crewAIInc:mainfrom
zhengyanglsun:docs/iflow-search-mcp
Open

docs(tools/search-research): add iFlow Search MCP (community)#5928
zhengyanglsun wants to merge 3 commits into
crewAIInc:mainfrom
zhengyanglsun:docs/iflow-search-mcp

Conversation

@zhengyanglsun
Copy link
Copy Markdown

@zhengyanglsun zhengyanglsun commented May 26, 2026

Adds a docs page for the iFlow Search MCP stdio server
(@iflow-ai/search-mcp@0.1.0) under docs/en/tools/search-research/,
mirroring the structure of youai-search.mdx. iFlow Search is a Chinese
search API operated by iFlow at platform.iflow.cn; the npm package
exposes three tools — iflow_web_search, iflow_image_search,
iflow_web_fetch — over MCP stdio.

The page documents wiring via MCPServerAdapter + StdioServerParameters
(per /en/mcp/stdio), the IFLOW_API_KEY env-var contract, parameter
tables for each tool, and a trust-boundary backstory sentence per
/en/mcp/security.

Validation Scope (called out on the page):

  • Verified: MCPServerAdapter spawned @iflow-ai/search-mcp@0.1.0,
    tools/list returned three tools, and direct CrewAIMCPTool.run
    calls against each tool returned real iFlow Search responses.
  • Not verified: the full CrewAI Agent + Task + LLM autonomous
    tool-selection loop. The snippet is documented as the recommended
    wiring shape but has not been smoke-tested end-to-end. The page
    states this explicitly so users wiring into a full Crew know to
    validate their own model's selection behavior.

Why this fits the repo:

  • youai-search.mdx already establishes the precedent for a
    third-party search MCP server with its own page under
    docs/en/tools/search-research/.
  • The package is published on npm (@iflow-ai/search-mcp@0.1.0) and on
    the Official MCP Registry as io.github.zhengyanglsun/iflow-search.
  • IFLOW_API_KEY lives only in the spawned server's process env; it is
    forwarded via StdioServerParameters(env=...) and should not be
    committed to source control.

Nav: appends en/tools/search-research/iflow-search to the
"Search & Research" group in docs/docs.json, in all 14 language nav
blocks — the same single-mdx-multi-nav pattern used for
en/tools/search-research/youai-search.

Community / third-party integration. No implied CrewAI endorsement.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for iFlow Search MCP integration, covering web search, image search, and web fetch tools
    • Included installation and configuration instructions for Node.js and CrewAI adapters, required/optional env vars, quick start examples, and security guidance
    • Updated documentation indexes/lists to include iFlow Search alongside the existing search tool where applicable

Review Change Stack

Adds a docs page for the community/third-party iFlow Search MCP stdio
server (@iflow-ai/search-mcp@0.1.0) under docs/en/tools/search-research/,
following the structure established by youai-search.mdx.

The page documents wiring iFlow Search into CrewAI via MCPServerAdapter
+ StdioServerParameters, lists the three tools (iflow_web_search,
iflow_image_search, iflow_web_fetch), and includes an explicit
Validation Scope callout: direct CrewAIMCPTool.run calls were verified,
but the full CrewAI Agent + Task + LLM autonomous tool-selection loop
was not.

Also appends en/tools/search-research/iflow-search to the Search &
Research nav group in docs/docs.json (14 language nav blocks, matching
the youai-search pattern).

Community / third-party integration. No implied crewAI endorsement.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9ce74248-de6f-42ef-a3e8-d3b766bf3fea

📥 Commits

Reviewing files that changed from the base of the PR and between ed20e66 and 67aec5d.

📒 Files selected for processing (1)
  • docs/en/tools/search-research/iflow-search.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/en/tools/search-research/iflow-search.mdx

📝 Walkthrough

Walkthrough

Adds a new iFlow Search documentation page describing three MCP tools, installation/configuration, a Python Quick Start, per-tool specs, security guidance, and registers the new page across fourteen tools lists in the docs navigation.

Changes

iFlow Search Documentation Integration

Layer / File(s) Summary
iFlow Search documentation page
docs/en/tools/search-research/iflow-search.mdx
New MDX file with frontmatter metadata, overview of three MCP tools (web search, image search, web fetch), installation instructions for CrewAI MCP adapter and Node.js server, environment variable configuration, Python Quick Start example using MCPServerAdapter, validation scope, per-tool parameter tables and JSON return shapes, security and trust-boundary guidance, and resource links.
Navigation registration across doc index
docs/docs.json
Fourteen repeated tools array blocks updated to include "en/tools/search-research/iflow-search" entry alongside the existing "en/tools/search-research/youai-search", ensuring the new tool is registered throughout the documentation navigation structure.

🐰 I hopped through docs to plant a seed,
A simple guide for searches you'll need.
Three tools, one page, quick start to run,
Keys kept safe, HTTPS for outbound fun,
Now iFlow and crews can both be led by one!

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 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(tools/search-research): add iFlow Search MCP (community)' directly and clearly summarizes the main change—adding documentation for the iFlow Search MCP integration under the search-research tools section.
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

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 and usage tips.

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 `@docs/en/tools/search-research/iflow-search.mdx`:
- Around line 59-70: The code reads iflow_key = os.getenv("IFLOW_API_KEY") but
proceeds even if it's None; add an explicit guard before constructing
StdioServerParameters that fails fast with a clear error (raise an exception or
call sys.exit) if iflow_key is falsy, and include the environment var name in
the message so auth failures are explicit; update the block that builds
StdioServerParameters to only run after verifying iflow_key is present.
🪄 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: 40563aeb-b284-431a-afb5-60cdc8bf253c

📥 Commits

Reviewing files that changed from the base of the PR and between bad64b1 and ed20e66.

📒 Files selected for processing (2)
  • docs/docs.json
  • docs/en/tools/search-research/iflow-search.mdx

Comment thread docs/en/tools/search-research/iflow-search.mdx
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