Add comprehensive Codegen MCP documentation #1161
Open
+453
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![codegen-sh[bot]](https://avatars.githubusercontent.com/in/321279?s=60&v=4){kind=small}
- Create detailed MCP documentation at docs/integrations/mcp.mdx - Add MCP to integrations section in docs.json navigation - Document existing 'codegen mcp' CLI command and all available options - Include step-by-step setup instructions for Cursor, Claude Desktop, and Cline - Document all available MCP tools: generate_codemod, create_agent_run, get_organizations, etc. - Add authentication guide with API key setup instructions - Include troubleshooting section with common issues and solutions - Provide best practices and real-world usage examples - Document transport options (stdio, HTTP) and port configuration - Add advanced configuration examples for custom setups Resolves CG-18858
|
I see a check failed - I'm on it! 🫡 |
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. 🚀 New features to boost your workflow:
|
- Remove trailing whitespace on line 38 - Remove extra newline at end of file - Fixes pre-commit check failures
|
✅ Fixed the failing pre-commit check in commit 68e0f81. Issue: The pre-commit check was failing due to formatting issues in the MCP documentation file. Fix:
The changes have been pushed to the PR branch and should now pass the pre-commit checks. |
jayhack
approved these changes
Jun 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive documentation for the Codegen Model Context Protocol (MCP) server, addressing the requirements in CG-18858.
What's Added
📚 New Documentation
docs/integrations/mcp.mdx: Complete MCP integration guidedocs/docs.json: Added MCP to integrations navigation🔧 Key Features Documented
codegen mcpcommandgenerate_codemod,create_agent_run, etc.🎯 Editor Integration Guides
📖 Comprehensive Sections
Technical Details
The documentation covers the existing MCP server implementation:
codegen mcpwith--host,--port,--transportoptionsTesting
✅ Verified
codegen mcpcommand functionality✅ Tested all command options and help text
✅ Confirmed stdio transport works correctly
✅ Validated HTTP transport shows correct port information
Impact
This documentation enables users to:
Resolves CG-18858
💻 View my work • About Codegen