youkii-xr commited on
Commit
8a1faeb
Β·
verified Β·
1 Parent(s): 675ad2e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -60
README.md CHANGED
@@ -16,82 +16,87 @@ tags:
16
 
17
  # π“€€ Egyptian Hieroglyph Detector (MCP Server)
18
 
19
- Welcome to our submission for the MCP Hackathon (Track 1: Building MCP)!
20
 
21
- This project bridges the gap between ancient history and modern AI Agents.
22
- It provides an MCP Server that allows Claude Desktop to "see" and identify Gardiner's Egyptian Hieroglyphs in any image.
23
-
24
- ---
25
 
26
  ## πŸŽ₯ Demo Video
27
 
28
- (Replace **YOUR_VIDEO_ID** in the link above with your actual YouTube video ID)
29
-
30
- ---
31
-
32
  ## 🚨🌍 IMPORTANT NOTICE FOR HACKATHON πŸ€–
33
 
34
- We are participating in the Creative Track (**building-mcp-track-creative**) because this tool unlocks new cultural and educational capabilities for AI agents.
35
-
36
- **πŸ”— Social Media Post:**
37
- [Link to your X/LinkedIn Post Here]
38
-
39
- ---
40
-
41
- ## 🌐 Project Overview
42
-
43
- This is not just a standard object detector.
44
- It is a **Hybrid Security Architecture** designed for the Model Context Protocol:
45
-
46
- ### **πŸ”“ Public Interface**
47
- An open MCP endpoint hosted on Hugging Face Spaces that anyone can connect to.
48
-
49
- ### **πŸ” Private Intelligence**
50
- The core intelligence (a fine-tuned YOLOv8 model) is hosted in a **Private Repository**.
51
- The Space acts as a secure proxy, authenticating with a secret token to load the weights without exposing them to the public.
52
 
53
- ### **πŸ›‘οΈ Secure Bridge**
54
- We built a custom **Upload Helper** tool that allows Claude Desktop to securely transfer local files from your computer to the cloud server for analysis.
55
-
56
- ---
57
 
58
  ## πŸ—‚οΈ Capabilities & Tools
59
 
60
- When connected to Claude, this server exposes **two powerful tools**:
61
-
62
- ### **1. `detect_hieroglyphs` (The AI Eye)**
63
 
64
- - **Purpose:** Takes an image input and performs object detection for Egyptian Hieroglyphs.
65
- - **Output:** Annotated image + JSON summary of symbol counts (e.g., `"3x Owl"`, `"1x Water"`).
66
- - **Model:** Custom-trained YOLOv8 model specialized on Gardiner signs.
67
 
68
- ---
69
-
70
- ### **2. `upload_file` (The Bridge)**
71
 
72
- - **Purpose:** Solves the β€œlocal vs. cloud” problem.
73
- - **Function:** Uploads a local file from your machine to the Space’s temporary storage so the AI can analyze it.
74
 
75
- ---
 
76
 
77
  ## πŸš€ How to Use (Claude Desktop)
78
 
79
  You can connect this tool to your own Claude Desktop right now!
80
 
81
- ### **πŸ“Œ Prerequisites**
82
-
83
- - Claude Desktop installed
84
- - Node.js & Python
85
- - Gradio MCP extension:
86
- ```sh
87
- pip install "gradio[mcp]"
88
-
89
- ### βš™οΈ Configuration
90
-
91
- Add the following JSON to your Claude Desktop configuration file.
92
-
93
- Windows path: %APPDATA%\Claude\claude_desktop_config.json
94
-
95
- Mac path: ~/Library/Application Support/Claude/claude_desktop_config.json
96
-
97
- Replace C:\\Claude_Work with the actual folder where you keep images, and update the URLs if your Space address differs.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
  # π“€€ Egyptian Hieroglyph Detector (MCP Server)
18
 
19
+ Welcome to our submission for the ​**MCP Hackathon (Track 1: Building MCP)** !
20
 
21
+ This project bridges the gap between ancient history and modern AI Agents. It provides an **MCP Server** that allows Ai Agents to "see" and identify Gardiner's Egyptian Hieroglyphs in any image.
 
 
 
22
 
23
  ## πŸŽ₯ Demo Video
24
 
25
+ (https://www.linkedin.com/posts/mariam-essam-ai-engineer_machinelearning-computervision-ai-activity-7400193629241143296-sWvC?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)
 
 
 
26
  ## 🚨🌍 IMPORTANT NOTICE FOR HACKATHON πŸ€–
27
 
28
+ We are participating in the **Creative Track** (`building-mcp-track-creative`) because this tool unlocks new cultural and educational capabilities for AI agents.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
30
+ πŸ”— **Social Media Post:**
31
+ [[Link to your X/LinkedIn Post Here](https://www.linkedin.com/posts/mariam-essam-ai-engineer_machinelearning-computervision-ai-activity-7400193629241143296-sWvC?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)]
 
 
32
 
33
  ## πŸ—‚οΈ Capabilities & Tools
34
 
35
+ When connected to Claude, this server exposes two powerful tools:
 
 
36
 
37
+ ### 1. `detect_hieroglyphs` (The AI Eye)
 
 
38
 
39
+ - **Purpose:** Takes an image input and performs object detection for Egyptian Hieroglyphs.
40
+ - **Output:** Returns an annotated image with bounding boxes drawn around symbols, plus a JSON summary of symbol counts (e.g., "3x Owl", "1x Water").
41
+ - **Model:** Powered by a custom-trained YOLOv8 model specialized on the Gardiner Sign List.
42
 
43
+ ### 2. `upload_file` (The Bridge)
 
44
 
45
+ - **Purpose:** Solves the "Local vs. Cloud" problem. Since the server runs in the cloud, it cannot see your `C:` drive.
46
+ - **Function:** Claude uses this tool to upload a specific local image to the secure temporary storage of the Space, returning a valid URL for the AI Eye to process.
47
 
48
  ## πŸš€ How to Use (Claude Desktop)
49
 
50
  You can connect this tool to your own Claude Desktop right now!
51
 
52
+ ### Prerequisites
53
+
54
+ - **Claude Desktop** installed.
55
+ - **Node.js** & **Python** installed.
56
+ - **Gradio MCP:** Run `pip install "gradio[mcp]"`​
57
+
58
+ ### Configuration
59
+
60
+ Add this to your `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/Library/Application Support/Claude/claude_desktop_config.json` (Mac):
61
+
62
+ ```
63
+ {
64
+ "mcpServers": {
65
+ "hieroglyph-ai": {
66
+ "command": "npx.cmd",
67
+ "args": [
68
+ "mcp-remote",
69
+ "[https://youkii-xr-hieroglyph-mcp-server.hf.space/gradio_api/mcp/](https://youkii-xr-hieroglyph-mcp-server.hf.space/gradio_api/mcp/)",
70
+ "--transport",
71
+ "streamable-http"
72
+ ]
73
+ },
74
+ "upload_helper": {
75
+ "command": "python",
76
+ "args": [
77
+ "-m",
78
+ "gradio",
79
+ "upload-mcp",
80
+ "[https://youkii-xr-hieroglyph-mcp-server.hf.space/](https://youkii-xr-hieroglyph-mcp-server.hf.space/)",
81
+ "C:\\Claude_Work"
82
+ ]
83
+ }
84
+ }
85
+ }
86
+ ```
87
+
88
+ *(Note: Change* *​`C:\\Claude_Work`​*​ *to the actual folder where you keep your images)*
89
+
90
+ ## 🧩 Technical Architecture
91
+
92
+ - **Framework:** Gradio 5.9.0 (with native MCP support)
93
+ - **Model:** Ultralytics YOLOv8 (Private Weights)
94
+ - **Storage:** Hugging Face Hub (Private Repo for Model, Public Space for Inference)
95
+ - **Protocol:** Model Context Protocol (MCP) via SSE (Server-Sent Events)
96
+
97
+ ## πŸ‘₯ Team
98
+
99
+ - **[youkii-xr]** – Ai Engineer, did the Ai model part
100
+ - **[mariam-essam]** – XR Developer, did the MCP and gradio part
101
+
102
+ *Built with ❀️ for the Hugging Face MCP Hackathon 2025*