Skip to content

Commit c4dda20

Browse files
committed
"Addig Local Settings and Updating readme"
1 parent 52a4fd4 commit c4dda20

File tree

2 files changed

+67
-35
lines changed

2 files changed

+67
-35
lines changed

README.md

Lines changed: 60 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,82 @@
1-
# Project Name
1+
# Python App with MCP Integration
22

3-
(short, 1-3 sentenced, description of the project)
3+
This guide walks you through setting up and connecting your Python application with the Model Context Protocol (MCP) Inspector.
44

5-
## Features
5+
---
66

7-
This project framework provides the following features:
7+
## 📦 Installation & Setup
88

9-
* Feature 1
10-
* Feature 2
11-
* ...
9+
### 1. Install Azure Functions Extensions
1210

13-
## Getting Started
11+
Ensure you're inside your Python working directory and have the Azure Functions Core Tools installed. Then, run:
1412

15-
### Prerequisites
13+
```bash
14+
func extensions install
15+
```
1616

17-
(ideally very short, if any)
17+
### 2. Create and Activate Virtual Environment
18+
19+
Make sure your Python virtual environment is activated before proceeding.
20+
21+
Create:
22+
23+
```bash
24+
python -m .venv env
25+
```
26+
27+
Activate:
28+
29+
```bash
30+
# Example (Linux/macOS)
31+
source venv/bin/activate
32+
33+
# Example (Windows)
34+
.\venv\Scripts\activate
35+
```
36+
37+
### 3. Activate Storage
38+
39+
Ensure that your storage is ready. If you are not using your own connection string in local.settings.json
40+
then be sure to run Azurite Blob Storage. Azurite is a VS Code extension used for storage emulation.
41+
42+
### 4. Start the Functions Host
1843

19-
- OS
20-
- Library version
21-
- ...
44+
Run the following command to start the Azure Functions host:
2245

23-
### Installation
46+
```bash
47+
func host start
48+
```
2449

25-
(ideally very short)
50+
## 🔗 Installation & Setup
2651

27-
- npm install [package name]
28-
- mvn install
29-
- ...
52+
### 5. Start MCP Inspector
3053

31-
### Quickstart
32-
(Add steps to get up and running quickly)
54+
Open a new terminal and run the MCP Inspector:
3355

34-
1. git clone [repository clone url]
35-
2. cd [repository name]
36-
3. ...
56+
```bash
57+
npx @modelcontextprotocol/inspector node build/index.js
58+
```
3759

60+
### 6. Configure Connection
3861

39-
## Demo
62+
Transport Type: SSE (Server-Sent Events)\
63+
URL: <http://0.0.0.0:7071/runtime/webhooks/mcp/sse>
4064

41-
A demo app is included to show how to use the project.
65+
### 7. Connect to Server
4266

43-
To run the demo, follow these steps:
67+
Click Connect within the MCP Inspector UI.
4468

45-
(Add steps to start up the demo)
69+
## 🧰 Explore Tools
4670

47-
1.
48-
2.
49-
3.
71+
Once generated:
5072

51-
## Resources
73+
- You can list all generated tools
74+
- Select any tool to begin interacting with your Python function through MCP
5275

53-
(Any additional resources or related projects)
76+
## ✅ Verification
5477

55-
- Link to supporting information
56-
- Link to similar sample
57-
- ...
78+
To verify the setup is working:
79+
80+
- Confirm the MCP Inspector shows the connection is active
81+
- Tools appear in the inspector panel after connection
82+
- Selecting a tool returns the expected behavior or response

src/local.settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"IsEncrypted": false,
3+
"Values": {
4+
"FUNCTIONS_WORKER_RUNTIME": "python",
5+
"AzureWebJobsStorage": "UseDevelopmentStorage=true"
6+
}
7+
}

0 commit comments

Comments
 (0)