Skip to content

Commit f777939

Browse files
committed
docs: update readme
Signed-off-by: Rai Siqueira <rai93siqueira@gmail.com>
1 parent 01876dd commit f777939

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A Model Context Protocol (MCP) server for Django applications, inspired by [Lara
77
## Table of Contents
88

99
- [Features](#features)
10+
- [Screenshots](#screenshots)
1011
- [Installation](#installation)
1112
- [For End Users](#for-end-users)
1213
- [For Development](#for-development)
@@ -35,6 +36,19 @@ A Model Context Protocol (MCP) server for Django applications, inspired by [Lara
3536
- **Read-Only**: All tools are safe, read-only operations
3637
- **Fast**: Built on [FastMCP](https://gofastmcp.com/) for efficient async operations
3738

39+
## Screenshots
40+
41+
<details>
42+
<summary>Click to view screenshots</summary>
43+
44+
### Django Telescope in Action
45+
46+
![Django Telescope Example](./assets/example_mcp01.png)
47+
48+
*Django Telescope MCP server providing Django project introspection through AI assistants (Example using [OpenCode](https://opencode.ai/))*
49+
50+
</details>
51+
3852
## Installation
3953

4054
### For End Users
@@ -204,7 +218,9 @@ django-telescope --settings myproject.settings
204218
django-telescope --settings myproject.settings --transport sse
205219
```
206220

207-
## Available Tools
221+
## Available Tools and Prompts
222+
223+
### Tools
208224

209225
### 1. `application_info`
210226
Get Django and Python versions, installed apps, middleware, database engine, and debug mode status.
@@ -246,10 +262,38 @@ Reverse a named URL pattern to get its actual URL path. Supports both positional
246262
### 10. `read_recent_logs`
247263
Read recent log entries with optional filtering by log level (DEBUG, INFO, WARNING, ERROR, CRITICAL).
248264

265+
### Prompts
266+
267+
MCP prompts provide reusable message templates to help guide interactions with AI assistants.
268+
269+
### 1. `search_django_docs`
270+
Generate a formatted prompt to help search for specific topics in Django documentation.
271+
272+
**Arguments:**
273+
- `topic`: The Django topic or feature to search for (e.g., "models", "queryset", "migrations", "authentication")
274+
275+
**Returns:**
276+
A formatted prompt that includes:
277+
- The current Django version being used
278+
- Direct links to the appropriate version of Django documentation
279+
- Guidance on what information to look for
280+
- Request for best practices and code examples
281+
282+
**Example topics:**
283+
- "models" - Learn about Django models and ORM
284+
- "queryset filtering" - Query optimization and filtering
285+
- "migrations" - Database schema management
286+
- "authentication" - User authentication and permissions
287+
- "middleware" - Request/response processing
288+
- "forms" - Form handling and validation
289+
290+
This prompt automatically adapts to your Django version (e.g., 5.2, 4.2) to ensure documentation compatibility.
291+
249292
## Example Usage with AI Assistants
250293

251294
Once configured, you can ask your AI assistant questions like:
252295

296+
**Using Tools:**
253297
- "What models are in this Django project?"
254298
- "Show me all URL patterns"
255299
- "What's the database schema for the users table?"
@@ -259,6 +303,11 @@ Once configured, you can ask your AI assistant questions like:
259303
- "Reverse the 'post_detail' URL pattern with pk=10"
260304
- "Show me recent error logs"
261305

306+
**Using Prompts:**
307+
- "Use the search_django_docs prompt for 'models'" - Get help finding Django model documentation
308+
- "Search Django docs for 'authentication'" - Learn about Django authentication
309+
- "Show me Django documentation about 'migrations'" - Migration best practices and guides
310+
262311
## Development & Testing
263312

264313
The project includes a comprehensive test suite and a fixture Django project for development:

assets/example_mcp01.png

470 KB
Loading

0 commit comments

Comments
 (0)