1- # Django MCP Server
1+ # Django Telescope
22
33A Model Context Protocol (MCP) server for Django applications, inspired by [ Laravel Boost] ( https://github.com/laravel/boost ) . This server exposes Django project information through MCP tools, enabling AI assistants to better understand and interact with Django codebases.
44
@@ -39,10 +39,10 @@ A Model Context Protocol (MCP) server for Django applications, inspired by [Lara
3939
4040``` bash
4141# Using uv (recommended)
42- uv pip install django-mcp
42+ uv pip install django-telescope
4343
4444# Or with pip
45- pip install django-mcp
45+ pip install django-telescope
4646```
4747
4848### For Development
@@ -51,8 +51,8 @@ If you want to contribute or run the latest development version:
5151
5252``` bash
5353# Clone the repository
54- git clone https://github.com/vinta/django-mcp .git
55- cd django-mcp
54+ git clone https://github.com/vinta/django-telescope .git
55+ cd django-telescope
5656
5757# Install uv if you haven't already
5858# On macOS/Linux:
@@ -65,7 +65,7 @@ powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
6565uv sync --dev
6666
6767# Verify installation
68- uv run django-mcp --help
68+ uv run django-telescope --help
6969```
7070
7171## Usage
@@ -77,13 +77,13 @@ The server requires access to your Django project's settings:
7777``` bash
7878# Set the Django settings module
7979export DJANGO_SETTINGS_MODULE=myproject.settings
80- django-mcp
80+ django-telescope
8181
8282# Or specify settings directly
83- django-mcp --settings myproject.settings
83+ django-telescope --settings myproject.settings
8484
8585# Run with SSE transport (default is stdio)
86- django-mcp --settings myproject.settings --transport sse
86+ django-telescope --settings myproject.settings --transport sse
8787```
8888
8989## AI Tools Setup
@@ -99,7 +99,7 @@ Add to your Claude Desktop configuration:
9999{
100100 "mcpServers" : {
101101 "django" : {
102- "command" : " django-mcp " ,
102+ "command" : " django-telescope " ,
103103 "args" : [" --settings" , " myproject.settings" ],
104104 "env" : {
105105 "DJANGO_SETTINGS_MODULE" : " myproject.settings" ,
@@ -120,9 +120,9 @@ Add to your Claude Desktop configuration:
120120``` json
121121{
122122 "mcpServers" : {
123- "django-mcp " : {
123+ "django-telescope " : {
124124 "command" : " uv" ,
125- "args" : [" run" , " django-mcp " , " --settings" , " myproject.settings" ],
125+ "args" : [" run" , " django-telescope " , " --settings" , " myproject.settings" ],
126126 "env" : {
127127 "DJANGO_SETTINGS_MODULE" : " myproject.settings"
128128 }
@@ -144,7 +144,7 @@ OpenAI ChatGPT Desktop supports MCP servers. Add to your configuration file:
144144{
145145 "mcpServers" : {
146146 "django" : {
147- "command" : " django-mcp " ,
147+ "command" : " django-telescope " ,
148148 "args" : [" --settings" , " myproject.settings" ],
149149 "env" : {
150150 "DJANGO_SETTINGS_MODULE" : " myproject.settings"
@@ -163,7 +163,7 @@ OpenAI ChatGPT Desktop supports MCP servers. Add to your configuration file:
163163``` json
164164{
165165 "django" : {
166- "command" : " django-mcp " ,
166+ "command" : " django-telescope " ,
167167 "args" : [" --settings" , " myproject.settings" ],
168168 "env" : {
169169 "DJANGO_SETTINGS_MODULE" : " myproject.settings"
@@ -180,7 +180,7 @@ Add to your Zed MCP configuration (`~/.config/zed/mcp.json`):
180180{
181181 "servers" : {
182182 "django" : {
183- "command" : " django-mcp " ,
183+ "command" : " django-telescope " ,
184184 "args" : [" --settings" , " myproject.settings" ],
185185 "env" : {
186186 "DJANGO_SETTINGS_MODULE" : " myproject.settings"
@@ -196,10 +196,10 @@ For any MCP-compatible client, you can run the server manually:
196196
197197``` bash
198198# Standard I/O transport (default)
199- django-mcp --settings myproject.settings
199+ django-telescope --settings myproject.settings
200200
201201# Server-Sent Events transport
202- django-mcp --settings myproject.settings --transport sse
202+ django-telescope --settings myproject.settings --transport sse
203203```
204204
205205## Available Tools
@@ -267,7 +267,7 @@ uv run python test_server.py
267267
268268# Run the MCP server with the test project
269269export PYTHONPATH=" ${PYTHONPATH} :./fixtures/testproject"
270- uv run django-mcp --settings testproject.settings
270+ uv run django-telescope --settings testproject.settings
271271
272272# Run linter
273273uv run ruff check .
@@ -289,7 +289,7 @@ Make sure you've set the `DJANGO_SETTINGS_MODULE` environment variable or used t
289289
290290``` bash
291291export DJANGO_SETTINGS_MODULE=myproject.settings
292- django-mcp
292+ django-telescope
293293```
294294
295295### PYTHONPATH Issues
@@ -298,7 +298,7 @@ If Django can't find your project modules, add your project directory to PYTHONP
298298
299299``` bash
300300export PYTHONPATH=" ${PYTHONPATH} :/path/to/your/project"
301- django-mcp --settings myproject.settings
301+ django-telescope --settings myproject.settings
302302```
303303
304304Or in your MCP client configuration:
@@ -314,12 +314,12 @@ Or in your MCP client configuration:
314314
315315### MCP Server Not Connecting
316316
317- 1 . Check that the ` django-mcp ` command is accessible in your PATH
317+ 1 . Check that the ` django-telescope ` command is accessible in your PATH
3183182 . Verify your MCP client configuration file syntax is valid JSON
3193193 . Check the logs in your AI tool (usually in settings or help menu)
3203204 . Try running the server manually to see any error messages:
321321 ``` bash
322- django-mcp --settings myproject.settings
322+ django-telescope --settings myproject.settings
323323 ```
324324
325325### Database Connection Issues
@@ -349,8 +349,8 @@ We welcome contributions from the community! Whether it's bug fixes, new feature
3493491 . ** Fork the repository** on GitHub
3503502 . ** Clone your fork** locally:
351351 ``` bash
352- git clone https://github.com/YOUR_USERNAME/django-mcp .git
353- cd django-mcp
352+ git clone https://github.com/YOUR_USERNAME/django-telescope .git
353+ cd django-telescope
354354 ```
3553553 . ** Install development dependencies** :
356356 ``` bash
@@ -384,7 +384,7 @@ We welcome contributions from the community! Whether it's bug fixes, new feature
384384
385385 # Test with the fixture project
386386 export PYTHONPATH=" ${PYTHONPATH} :./fixtures/testproject"
387- uv run django-mcp --settings testproject.settings
387+ uv run django-telescope --settings testproject.settings
388388 ```
3893894 . ** Commit your changes** :
390390 ``` bash
0 commit comments