OppaAI commited on
Commit
660d98a
Β·
verified Β·
1 Parent(s): 0994822

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -54
README.md CHANGED
@@ -8,88 +8,67 @@ sdk_version: 6.0.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
- short_description: CV MCP Client with tags for MCP 1st Birthday party Hackathon
12
  tags:
13
  - mcp-in-action-track-creative
14
  ---
15
 
16
- Check out the Hackathon details at: https://huggingface.co/MCP-1st-Birthday
17
 
18
- Social media post link:
19
- https://discord.com/channels/879548962464493619/
20
 
21
- # πŸŽ₯ Computer Vision MCP Client
 
22
 
23
- A Model Context Protocol (MCP) client that streams webcam images and retrieves detailed scene analysis from the MCP server.
 
24
 
25
  ---
26
 
27
- ## 🌟 Features
28
 
29
- - Real-time scene description
30
- - Human detection
31
- - Animals and objects detection
32
- - Environment classification (indoor/outdoor)
33
- - Lighting condition analysis
34
- - Hazards identification
35
- - Optimized for context window efficiency
36
 
37
  ---
38
 
39
  ## πŸ”§ How It Works
40
 
41
- This Gradio Space uses a MCP server to analyze webcam images:
42
 
43
- 1. Capture an image via webcam.
44
- 2. Convert the image to Base64 format.
45
- 3. Send the image along with your Hugging Face token to the MCP server.
46
  4. Receive detailed scene analysis, including:
47
- - Description of the scene
48
- - Detected humans
49
- - Animals and objects
50
- - Environment type (indoor/outdoor)
51
- - Lighting condition
52
- - Hazards
53
 
54
  ---
55
 
56
  ## ⚑ Demo
57
 
58
- Works on PC and phone, and robot with camera.
59
- Use your webcam/phone camera to stream images and receive real-time scene analysis.
60
 
61
- Demo Video of using the CV MCP Server to analyze via the camera video feed of my robot:
62
- https://photos.app.goo.gl/guxui1EsdPNoL4mw7
63
 
 
 
64
 
65
  ---
66
 
67
  ## πŸ”‘ Requirements
68
 
69
- - **Hugging Face API Token** is required for the MCP server to process images.
70
- - Set your token as an environment variable locally: `HF_TOKEN`.
71
- - Without a valid token, the app will display an error message.
72
 
73
- > **Note:** This project uses a personal Hugging Face token for server access. Public users of the Space will be using your account, so be mindful of token usage limits.
74
-
75
- ---
76
-
77
- ## πŸš€ Usage
78
-
79
- 1. Open the Space and allow webcam access.
80
- 2. Stream images via the webcam.
81
- 3. View the outputs in the textboxes:
82
- - Description
83
- - Environment
84
- - Indoor/Outdoor
85
- - Lighting Condition
86
- - Human Detected
87
- - Animals Detected
88
- - Objects Detected
89
- - Hazards Identified
90
-
91
- ---
92
-
93
- ## ⚠️ Note
94
-
95
- This project demonstrates a client-side MCP integration. The token used in this Space is tied to the deployer's Hugging Face account. To avoid exposing your token to the public, consider using OAuth login so users can use their own Hugging Face tokens.
 
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
+ short_description: Computer Vision MCP Client for MCP 1st Birthday Hackathon
12
  tags:
13
  - mcp-in-action-track-creative
14
  ---
15
 
16
+ # πŸŽ₯ CV MCP Client
17
 
18
+ A **Computer Vision Model Context Protocol (MCP) Client** that streams webcam images and provides detailed scene analysis in real time, designed for the **MCP 1st Birthday Hackathon**.
 
19
 
20
+ Check out the Hackathon details [here](https://huggingface.co/MCP-1st-Birthday).
21
+ Join the community discussion on [Discord](https://discord.com/channels/879548962464493619/).
22
 
23
+ Demo video of the CV MCP Server analyzing the video feed from my robot:
24
+ [Demo Video](https://photos.app.goo.gl/guxui1EsdPNoL4mw7)
25
 
26
  ---
27
 
28
+ ## 🌟 Key Features
29
 
30
+ - Real-time scene description
31
+ - Human detection
32
+ - Animal and object detection
33
+ - Environment classification (indoor/outdoor)
34
+ - Lighting condition analysis
35
+ - Hazards identification
36
+ - Optimized for efficient context window usage
37
 
38
  ---
39
 
40
  ## πŸ”§ How It Works
41
 
42
+ This Gradio Space interacts with an MCP server to analyze webcam images:
43
 
44
+ 1. Capture an image from your webcam.
45
+ 2. Convert the image to **Base64 format**.
46
+ 3. Send the image along with your **Hugging Face API token** to the MCP server.
47
  4. Receive detailed scene analysis, including:
48
+ - Scene description
49
+ - Detected humans
50
+ - Detected animals and objects
51
+ - Environment type (indoor/outdoor)
52
+ - Lighting condition
53
+ - Hazards
54
 
55
  ---
56
 
57
  ## ⚑ Demo
58
 
59
+ Compatible with **PC, mobile, and robots with cameras**.
 
60
 
61
+ Stream images via your webcam or phone camera to receive real-time scene analysis.
 
62
 
63
+ Watch a demo video of the CV MCP Server analyzing the video feed from my robot:
64
+ [Demo Video](https://photos.app.goo.gl/guxui1EsdPNoL4mw7)
65
 
66
  ---
67
 
68
  ## πŸ”‘ Requirements
69
 
70
+ - **Hugging Face API Token** is required for MCP server access.
71
+ - Set your token as an environment variable:
 
72
 
73
+ ```bash
74
+ export HF_TOKEN=your_huggingface_token