Skip to content

fix remove unused mcp function args comment#139

Open
MrJohnDev wants to merge 1 commit into
makeplane:mainfrom
MrJohnDev:fix-mcp-args-comments
Open

fix remove unused mcp function args comment#139
MrJohnDev wants to merge 1 commit into
makeplane:mainfrom
MrJohnDev:fix-mcp-args-comments

Conversation

@MrJohnDev

@MrJohnDev MrJohnDev commented Jun 4, 2026

Copy link
Copy Markdown

Description

Some LLM models see the function description, require the workspace_slug in arguments, and substitute it when executing the functions. However, the functions themselves don't accept this argument.

LLM models try to pass the workspace_slug because they see it in the comment and assume it's needed.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Test Scenarios

Test MCP on small models like Gemma-4-e2b in LM Studio

Summary by CodeRabbit

  • Documentation
    • Removed extraneous parameter documentation from tool docstrings across multiple modules (cycles, epics, initiatives, intake, modules, and projects). No functional changes were made.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e92867e9-3c9e-4034-bbc4-a90cf7d19aac

📥 Commits

Reviewing files that changed from the base of the PR and between 838c572 and 7bc7190.

📒 Files selected for processing (6)
  • plane_mcp/tools/cycles.py
  • plane_mcp/tools/epics.py
  • plane_mcp/tools/initiatives.py
  • plane_mcp/tools/intake.py
  • plane_mcp/tools/modules.py
  • plane_mcp/tools/projects.py
💤 Files with no reviewable changes (6)
  • plane_mcp/tools/intake.py
  • plane_mcp/tools/cycles.py
  • plane_mcp/tools/projects.py
  • plane_mcp/tools/epics.py
  • plane_mcp/tools/initiatives.py
  • plane_mcp/tools/modules.py

📝 Walkthrough

Walkthrough

This PR removes extraneous workspace_slug parameter documentation from Args: sections of MCP tool docstrings across five tool modules. No function signatures, runtime logic, or behavior are modified—all changes are purely docstring corrections.

Changes

MCP Tool Docstring Cleanup

Layer / File(s) Summary
Cycles tool docstring parameter fixes
plane_mcp/tools/cycles.py
Removed workspace_slug documentation from nine cycle-related tool docstrings: list_cycles, create_cycle, retrieve_cycle, update_cycle, delete_cycle, list_archived_cycles, remove_work_item_from_cycle, transfer_cycle_work_items, and unarchive_cycle.
Epics tool docstring parameter fix
plane_mcp/tools/epics.py
Removed workspace_slug documentation from the create_epic tool docstring.
Initiatives tool docstring parameter fixes
plane_mcp/tools/initiatives.py
Removed workspace_slug documentation from five initiative-related tool docstrings: list_initiatives, create_initiative, retrieve_initiative, update_initiative, and delete_initiative.
Intake tool docstring parameter fixes
plane_mcp/tools/intake.py
Removed workspace_slug documentation from four intake-related tool docstrings: list_intake_work_items, create_intake_work_item, retrieve_intake_work_item, and delete_intake_work_item.
Modules tool docstring parameter fixes
plane_mcp/tools/modules.py
Removed workspace_slug documentation from nine module-related tool docstrings: list_modules, create_module, retrieve_module, update_module, delete_module, list_archived_modules, remove_work_item_from_module, archive_module, and unarchive_module.
Projects tool docstring parameter fixes
plane_mcp/tools/projects.py
Removed workspace_slug documentation from nine project-related tool docstrings: list_projects, create_project, retrieve_project, update_project, delete_project, get_project_worklog_summary, get_project_members, get_project_features, and update_project_features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • Prashant-Surya

Poem

A hop through the docs, line by line,
Workspace slugs vanish—now docstrings align! 🐰
No logic was changed, just words swept away,
Cleaner, more truthful, hooray, hooray! ✨

🚥 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 clearly summarizes the main change: removing unused workspace_slug parameter documentation from MCP function docstrings.
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.

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