theanupdas commited on
Commit
45d5c6a
Β·
verified Β·
1 Parent(s): b1b03f0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -55
README.md CHANGED
@@ -1,55 +1,64 @@
1
- # MCP Demo Project
2
-
3
- This project demonstrates a simple Model Context Protocol (MCP) server integration using Gradio and Python. It includes a sample database and basic server logic for experimentation and learning purposes.
4
-
5
- ## Project Structure
6
-
7
- ```
8
- mcp_demo/
9
- β”œβ”€β”€ app.py # Main application entry point
10
- β”œβ”€β”€ requirements.txt # Python dependencies
11
- β”œβ”€β”€ server.py # MCP server implementation
12
- β”œβ”€β”€ data/
13
- β”‚ └── northwind.db # Sample SQLite database
14
- └── __pycache__/ # Python bytecode cache
15
- ```
16
-
17
- ## Features
18
- - MCP server endpoint (compatible with Gradio MCP client)
19
- - Example SQLite database (Northwind)
20
- - Simple API for experimentation
21
-
22
- ## Setup Instructions
23
-
24
- 1. **Clone the repository** (if not already):
25
- ```sh
26
- git clone <repo-url>
27
- cd mcp_demo
28
- ```
29
-
30
- 2. **Install dependencies:**
31
- ```sh
32
- pip install -r requirements.txt
33
- ```
34
-
35
- 3. **Run the server:**
36
- ```sh
37
- python server.py
38
- ```
39
- or
40
- ```sh
41
- python app.py
42
- ```
43
-
44
- 4. **Access the MCP server:**
45
- - The server will be available at `http://127.0.0.1:7860/gradio_api/mcp/sse` (or as configured in `.vscode/mcp.json`).
46
-
47
- ## Configuration
48
- - The `.vscode/mcp.json` file contains the MCP server URL configuration for local or remote use.
49
-
50
- ## Requirements
51
- - Python 3.8+
52
- - pip
53
-
54
- ## License
55
- This project is for educational and demonstration purposes.
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ title: MCP test
4
+ sdk: gradio
5
+ emoji: πŸš€
6
+ colorFrom: blue
7
+ colorTo: green
8
+ short_description: This project demonstrates a simple Model Context Protocol (M
9
+ ---
10
+ # MCP Demo Project
11
+
12
+ This project demonstrates a simple Model Context Protocol (MCP) server integration using Gradio and Python. It includes a sample database and basic server logic for experimentation and learning purposes.
13
+
14
+ ## Project Structure
15
+
16
+ ```
17
+ mcp_demo/
18
+ β”œβ”€β”€ app.py # Main application entry point
19
+ β”œβ”€β”€ requirements.txt # Python dependencies
20
+ β”œβ”€β”€ server.py # MCP server implementation
21
+ β”œβ”€β”€ data/
22
+ β”‚ └── northwind.db # Sample SQLite database
23
+ └── __pycache__/ # Python bytecode cache
24
+ ```
25
+
26
+ ## Features
27
+ - MCP server endpoint (compatible with Gradio MCP client)
28
+ - Example SQLite database (Northwind)
29
+ - Simple API for experimentation
30
+
31
+ ## Setup Instructions
32
+
33
+ 1. **Clone the repository** (if not already):
34
+ ```sh
35
+ git clone <repo-url>
36
+ cd mcp_demo
37
+ ```
38
+
39
+ 2. **Install dependencies:**
40
+ ```sh
41
+ pip install -r requirements.txt
42
+ ```
43
+
44
+ 3. **Run the server:**
45
+ ```sh
46
+ python server.py
47
+ ```
48
+ or
49
+ ```sh
50
+ python app.py
51
+ ```
52
+
53
+ 4. **Access the MCP server:**
54
+ - The server will be available at `http://127.0.0.1:7860/gradio_api/mcp/sse` (or as configured in `.vscode/mcp.json`).
55
+
56
+ ## Configuration
57
+ - The `.vscode/mcp.json` file contains the MCP server URL configuration for local or remote use.
58
+
59
+ ## Requirements
60
+ - Python 3.8+
61
+ - pip
62
+
63
+ ## License
64
+ This project is for educational and demonstration purposes.