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

Adding Readme file

Browse files
Files changed (1) hide show
  1. README.md +55 -14
README.md CHANGED
@@ -1,14 +1,55 @@
1
- ---
2
- title: Inspire Quote
3
- emoji: πŸ’»
4
- colorFrom: gray
5
- colorTo: red
6
- sdk: gradio
7
- sdk_version: 5.33.0
8
- app_file: app.py
9
- pinned: false
10
- license: apache-2.0
11
- short_description: MCP server test
12
- ---
13
-
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.