Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@jimini55
Copy link
Contributor

@jimini55 jimini55 commented Dec 26, 2025

  • Add deprecation banner to server README
  • Add deprecation warnings to all tool docstrings
  • Add Python DeprecationWarning to all tools
  • Mark as deprecated in main README tables
  • Reference RFC RFC: Code Doc Gen MCP Server Deprecation #2004 for details

Fixes #2004

Summary

Add deprecation notices to the Code Documentation Generation MCP Server per RFC #2004. This server is being deprecated as modern LLMs now handle documentation generation more effectively using native file and code intelligence tools.

Changes

  • Deprecation banner in server README with RFC reference
  • Deprecation warnings in all tool docstrings
  • Python DeprecationWarning in all tool functions
  • Marked as deprecated in main repository README tables

User experience

Before: Users could install and use the server without any indication it's deprecated.

After: Users see clear deprecation warnings:

  • Deprecation banner at top of README when viewing documentation
  • Warning messages when tools are invoked
  • "DEPRECATED" label in main README server tables

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have reviewed the contributing guidelines
  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented

Is this a breaking change? Y (Deprecation)

RFC issue number: #2004, #1193

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

- Add deprecation banner to server README
- Add deprecation warnings to all tool docstrings
- Add Python DeprecationWarning to all tools
- Mark as deprecated in main README tables
- Reference RFC #2004 for details
@jimini55 jimini55 marked this pull request as ready for review December 26, 2025 22:40
@jimini55 jimini55 requested review from a team as code owners December 26, 2025 22:40
@codecov
Copy link

codecov bot commented Dec 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.53%. Comparing base (71a9597) to head (79c8461).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2006      +/-   ##
==========================================
- Coverage   90.53%   90.53%   -0.01%     
==========================================
  Files         861      861              
  Lines       64686    64691       +5     
  Branches    10407    10407              
==========================================
+ Hits        58566    58570       +4     
  Misses       3784     3784              
- Partials     2336     2337       +1     

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jimini55 jimini55 changed the title Add deprecation notices to code-doc-gen-mcp-server per RFC #2004 feat: Add deprecation notices to code-doc-gen-mcp-server per RFC #2004 Dec 26, 2025
Fix trailing whitespace and ruff formatting in server.py and README.md
Copy link
Member

@scottschreckengaust scottschreckengaust left a comment

Choose a reason for hiding this comment

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

LGTM

@scottschreckengaust scottschreckengaust self-assigned this Dec 27, 2025
@scottschreckengaust scottschreckengaust added the ready-for-merge Folks believe this is ready to merge label Dec 27, 2025
@scottschreckengaust scottschreckengaust moved this from To triage to In progress in awslabs/mcp Project Dec 27, 2025
@scottschreckengaust scottschreckengaust requested review from a team December 27, 2025 00:00
@scottschreckengaust scottschreckengaust added this pull request to the merge queue Dec 29, 2025
Merged via the queue into main with commit dd13f39 Dec 29, 2025
223 checks passed
@scottschreckengaust scottschreckengaust deleted the code-doc-deprecation branch December 29, 2025 23:13
@github-project-automation github-project-automation bot moved this from In progress to Done in awslabs/mcp Project Dec 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge Folks believe this is ready to merge

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

RFC: Code Doc Gen MCP Server Deprecation

3 participants