feat(mcp-proxy): improve mcp_call detail parameter documentation

[Joao208]

O que muda

A description do tool mcp_call e o schema Zod do parâmetro detail agora explicam explicitamente o comportamento de shaping do proxy:

• Sem detail (default): strip de campos de metadata (id, url, created_at, etc.), truncamento de texto em 500 chars, arrays limitados a 5 items
• Com detail=true: preserva todos os campos, texto até 1500 chars, arrays completos

Por que

LLMs não sabiam quando usar detail=true porque a description anterior era genérica ("Returns normalized, token-efficient output"). Isso causava respostas incompletas — ex: threads do Slack com 12 mensagens retornando só 5 porque campos eram stripped e dados truncados.

Mudanças

• server.ts: description do mcp_call agora documenta o comportamento de shaping e quando usar detail=true
• types.ts: campo detail no Zod schema agora tem .describe() com explicação
• package.json: bump 1.10.0 → 1.11.0

Summary by CodeRabbit

Release Notes

• Documentation
  • Enhanced documentation to clarify parameter behavior: standard mode truncates text to 500 characters and limits arrays to 5 items; detailed mode preserves all fields, extends text truncation to 1500 characters, and includes complete arrays.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Version bump to 1.11.0 with enhanced documentation for the mcp_call tool's detail parameter, detailing output shaping behavior across the tool description and Zod schema.

Changes

Cohort / File(s)	Summary
Documentation & Metadata Updates packages/mcp-proxy/package.json, packages/mcp-proxy/src/server.ts, packages/mcp-proxy/src/types.ts	Added detailed documentation of the detail parameter's behavior: false/default strips metadata, truncates to 500 chars, limits arrays to 5 items; true preserves all fields, truncates to 1500 chars, preserves full arrays. Updates package version from 1.10.0 to 1.11.0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop, skip, and version bump we make,
With detail descriptions at stake!
True reveals all fields, pristine and whole,
False keeps it trim—a data control!
Now users will know which knob to turn,
For clarity's lessons, forever we learn! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: improving documentation for the mcp_call detail parameter across tool metadata and schema.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch joao-barros-/-improve-mcp-call-detail-docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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