Skip to content

Commit e4596fc

Browse files
committed
fix: update readme
1 parent ce8cffe commit e4596fc

File tree

1 file changed

+64
-0
lines changed
  • codegen-examples/examples/codegen-mcp-server

1 file changed

+64
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Codegen MCP Server
2+
3+
<p align="center">
4+
<a href="https://docs.codegen.com">
5+
<img src="https://i.imgur.com/6RF9W0z.jpeg" />
6+
</a>
7+
</p>
8+
9+
<h2 align="center">
10+
An MCP server implementation that integrates the codegen sdk.
11+
12+
</h2>
13+
14+
<div align="center">
15+
16+
[![Documentation](https://img.shields.io/badge/Docs-docs.codegen.com-purple?style=flat-square)](https://docs.codegen.com)
17+
[![License](https://img.shields.io/badge/Code%20License-Apache%202.0-gray?&color=gray)](https://github.com/codegen-sh/codegen-sdk/tree/develop?tab=Apache-2.0-1-ov-file)
18+
19+
</div>
20+
21+
This example demonstrates how to run a Model Control Protocol (MCP) server that integrates with Codegen. The server provides:
22+
23+
1. A standardized interface for model inference
24+
2. Integration with Codegen's core functionality, parsing codebases and executing codemods
25+
3. Support for various LLM providers through the MCP protocol
26+
27+
28+
## Quick Start
29+
30+
### Prerequisites
31+
It's recommended to use `uv` to install the package.
32+
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
33+
34+
This MCP server runs on python 3.12+
35+
- [python](https://www.python.org/downloads/) 3.12+
36+
37+
38+
### Direct Execution
39+
40+
1. No installation is necessary, with the following command. Run this command directly or add it your `.json` mcp config file.
41+
42+
```bash
43+
uvx --from 'git+https://github.com/codegen-sh/codegen-sdk.git@ce8cffe#egg=codegen-mcp-server&subdirectory=codegen-examples/examples/codegen-mcp-server' codegen-mcp-server
44+
```
45+
46+
47+
### Example MCP Config
48+
Here is an example mcp config that can be used with Cline or Claude desktop to integrate this MCP server
49+
50+
```json
51+
{
52+
"mcpServers": {
53+
"codegen-mcp": {
54+
"command": "uvx",
55+
"args": [
56+
"--from", "git+https://github.com/codegen-sh/codegen-sdk.git@ce8cffe#egg=codegen-mcp-server&subdirectory=codegen-examples/examples/codegen-mcp-server", "codegen-mcp-server"
57+
],
58+
"disabled": false,
59+
"autoApprove": []
60+
}
61+
}
62+
}
63+
64+
```

0 commit comments

Comments
 (0)