feat: improve MCP tool descriptions to address Glama score issues

[shenxianpeng]

Summary

Updates all MCP tool docstrings to fix issues identified by the Glama.ai MCP server score review (scores ranged from 2.6 to 4.0/5.0).

Changes

All 8 tools updated: server_health, validate_commit_message, validate_branch_name, validate_author_info, validate_push_safety, validate_commit_context, validate_repository_state, describe_validation_rules

Scoring dimensions addressed

Dimension	Before	After
Behavior (was 2/5)	No side-effect disclosure	All tools state Read-only upfront
Parameters (was 1-2/5)	0% schema description coverage	Every param documented: config, repo_path, config_path + tool-specific params
Completeness (was 2/5)	Single sentence descriptions	Return format (status + per-check results) described for all tools
Usage Guidelines (was 2-3/5)	No sibling guidance	Each tool explains when to use vs alternatives

Verification

• python3 syntax check — OK
• All 8 tools confirmed to have read-only, Parameters:, and return value documentation

Summary by CodeRabbit

• Documentation
  • Expanded tool descriptions to make validation responses easier to understand.
  • Clarified what each health/check tool returns, including overall status and per-check details.
  • Added clearer guidance on when to use each tool and what optional parameters do.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e944bd28-c6d5-4564-b01c-dab17d592770

📥 Commits

Reviewing files that changed from the base of the PR and between 1dc8fba and 3f0c554.

📒 Files selected for processing (1)

• src/commit_check_mcp/server.py

---

📝 Walkthrough

Walkthrough

This PR expands docstrings for eight MCP tools in server.py (server_health, validate_commit_message, validate_branch_name, validate_author_info, validate_push_safety, validate_commit_context, validate_repository_state, describe_validation_rules), adding details on behavior, return structure, usage guidance, and parameters. No functional code changes.

Changes

Tool docstring documentation

Layer / File(s)	Summary
Expanded MCP tool docstrings src/commit_check_mcp/server.py	Docstrings for server_health and seven validation tools are expanded to describe read-only behavior, structured return payloads, usage guidance, and parameter defaults.

Estimated code review effort: 1 (Trivial) | ~5 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 accurately summarizes the main change: improving MCP tool descriptions/docstrings to fix Glama score issues.
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.

✨ 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 feature/improve-tool-descriptions-for-glama-score

---

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.}

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1dc8fba) to head (3f0c554).

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #15   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          209       209           
=========================================
  Hits           209       209           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.