youkii-xr commited on
Commit
2ef9678
Β·
verified Β·
1 Parent(s): 5a4c8d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -30
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: Hieroglyph Mcp Server
3
  emoji: πŸ‘
4
  colorFrom: gray
5
  colorTo: yellow
@@ -7,52 +7,78 @@ sdk: gradio
7
  sdk_version: 6.0.1
8
  app_file: app.py
9
  pinned: false
10
- short_description: Detect and classify hieroglyphs to its Gardiner code
11
  tags:
12
  - building-mcp-track-creative
 
 
 
13
  - mcp-server
14
  ---
15
 
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
  ## πŸ‘₯ Team
24
 
25
- - **[youkii-xr](https://huggingface.co/youkii-xr)** – XR Developer, did the MCP and Gradio part <br> [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/youkii-xr/)
26
- - **[mariam-essam](https://huggingface.co/mariam-essam)** – AI Engineer, did the AI model part <br> [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/mariam-essam-ai-engineer/)
27
 
28
  ## πŸŽ₯ Demo Video
29
 
30
- | Claude Desktop MCP Server | Hieroglyphic Gradio Web App |
31
- | :---: | :---: |
32
- | [![Claude Desktop Demo](https://img.youtube.com/vi/Vvlu6sDzsBE/hqdefault.jpg)](https://youtu.be/Vvlu6sDzsBE) | [![Gradio App Demo](https://img.youtube.com/vi/GSXIpSummOU/hqdefault.jpg)](https://youtu.be/GSXIpSummOU) |
33
-
34
- ## 🚨🌍 IMPORTANT NOTICE FOR HACKATHON πŸ€–
35
 
36
- We are participating in the **Creative Track** (`building-mcp-track-creative`) because this tool unlocks new cultural and educational capabilities for AI agents.
37
 
38
  πŸ”— **Social Media Post:**
39
- [[Gradio App](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)]<br>
40
- [[MCP Server](https://www.linkedin.com/posts/youkii-xr_huggingface-mcp-ai-activity-7400474001891819520-tTa3?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)]
 
 
41
 
42
  ## πŸ—‚οΈ Capabilities & Tools
43
 
44
- When connected to Claude, this server exposes two powerful tools:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
 
46
- ### 1. `detect_hieroglyphs` (The AI Eye)
 
 
47
 
48
- - **Purpose:** Takes an image input and performs object detection for Egyptian Hieroglyphs.
49
- - **Output:** Returns an annotated image with bounding boxes drawn around symbols, plus a JSON summary of symbol counts (e.g., "3x Owl", "1x Water").
50
- - **Model:** Powered by a custom-trained YOLOv8 model specialized on the Gardiner Sign List.
51
 
52
- ### 2. `upload_file` (The Bridge)
 
 
53
 
54
- - **Purpose:** Solves the "Local vs. Cloud" problem. Since the server runs in the cloud, it cannot see your `C:` drive.
55
- - **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.
 
56
 
57
  ## πŸš€ How to Use (Claude Desktop)
58
 
@@ -71,23 +97,23 @@ Add this to your `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/L
71
  ```
72
  {
73
  "mcpServers": {
74
- "hieroglyph-ai": {
75
- "command": "npx.cmd",
76
  "args": [
77
  "mcp-remote",
78
- "[https://youkii-xr-hieroglyph-mcp-server.hf.space/gradio_api/mcp/](https://youkii-xr-hieroglyph-mcp-server.hf.space/gradio_api/mcp/)",
79
  "--transport",
80
  "streamable-http"
81
  ]
82
  },
83
  "upload_helper": {
84
- "command": "python",
85
  "args": [
86
  "-m",
87
  "gradio",
88
  "upload-mcp",
89
- "[https://youkii-xr-hieroglyph-mcp-server.hf.space/](https://youkii-xr-hieroglyph-mcp-server.hf.space/)",
90
- "C:\\Claude_Work"
91
  ]
92
  }
93
  }
@@ -98,7 +124,7 @@ Add this to your `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/L
98
 
99
  ## 🧩 Technical Architecture
100
 
101
- - **Framework:** Gradio 5.9.0 (with native MCP support)
102
  - **Model:** Ultralytics YOLOv8 (Private Weights)
103
  - **Storage:** Hugging Face Hub (Private Repo for Model, Public Space for Inference)
104
  - **Protocol:** Model Context Protocol (MCP) via SSE (Server-Sent Events)
 
1
  ---
2
+ title: Rosetta Decoder
3
  emoji: πŸ‘
4
  colorFrom: gray
5
  colorTo: yellow
 
7
  sdk_version: 6.0.1
8
  app_file: app.py
9
  pinned: false
10
+ short_description: Detect & Translate hieroglyphics
11
  tags:
12
  - building-mcp-track-creative
13
+ - building-mcp-track-consumer
14
+ - mcp-in-action-track-creative
15
+ - mcp-in-action-track-consumer
16
  - mcp-server
17
  ---
18
 
19
 
20
  # π“€€ Egyptian Hieroglyph Detector (MCP Server)
21
 
22
+ 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 Hieroglyphs in any image.
 
 
23
 
24
  ## πŸ‘₯ Team
25
 
26
+ - **[youkii-xr](https://huggingface.co/youkii-xr)** – XR Developer, did the MCP and Gradio part<br> [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/youkii-xr/)
27
+ - **[MariamEssam204](https://huggingface.co/MariamEssam204)** – AI Engineer, did the AI model part <br> [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/mariam-essam-ai-engineer/)
28
 
29
  ## πŸŽ₯ Demo Video
30
 
31
+ | Gradio App V2 | Mobile Camera Test | MCP Server |
32
+ | :---: | :---: | :---: |
33
+ | [![Gradio App V2](https://img.youtube.com/vi/nnQnNfJtSWM/hqdefault.jpg)](https://youtu.be/nnQnNfJtSWM) | [![Mobile Camera Test](https://img.youtube.com/vi/wZKBVYAZwZ4/hqdefault.jpg)](https://youtu.be/wZKBVYAZwZ4) | [![MCP Server](https://img.youtube.com/vi/Vvlu6sDzsBE/hqdefault.jpg)](https://youtu.be/Vvlu6sDzsBE) |
 
 
34
 
 
35
 
36
  πŸ”— **Social Media Post:**
37
+ [[Gradio App - V2](https://www.linkedin.com/posts/youkii-xr_our-hieroglyphic-ai-detector-just-got-a-major-activity-7400855950632411136-5Z9Y?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)]<br>
38
+ [[Mobile camera test](https://www.linkedin.com/posts/mariam-essam-ai-engineer_productdevelopment-dataaugmentation-realtimeai-activity-7400635609570205696-a9JN?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)]<br>
39
+ [[Gradio App - V1](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)]<br>
40
+ [[MCP Server - V1](https://www.linkedin.com/posts/youkii-xr_huggingface-mcp-ai-activity-7400474001891819520-tTa3?utm_source=social_share_send&utm_medium=member_desktop_web&rcm=ACoAADSn0yMBo1MdVldbeoL5OxUZo2-CMJKUKOM)]
41
 
42
  ## πŸ—‚οΈ Capabilities & Tools
43
 
44
+ #### Hieroglyphs Detection:
45
+ * trained on 400+ different glyphs
46
+ * able to detect with high confidence
47
+
48
+ #### Translation
49
+ * **Mystical prophecy** : translates for tourists and non-academics as a story
50
+ * **Academic Translation** : a linguistics breakdown of symbols and their meaning and how they fit together
51
+
52
+ #### Analytics
53
+ * **Spatial Heatmaps** : visualizes where glyphs are clustered on the wall / papyrus
54
+ * **Confidence Charts** : Shows how sure the AI is about every symbol
55
+ * **Frequency Analysis** : Counts the occurrence of distinguished symbols
56
+
57
+ #### Digital Encyclopedia
58
+ * Includes a searchable database of supported Gardiner Codes with descriptions and transliteration
59
+
60
+ #### Downloadable Results
61
+ * Download the detection result with bounding boxes surrounding each glyph on the wall / papyrus
62
+ * Download glyphs gallery as a zip containing all glyphs detected individually cropped
63
+
64
+ ## πŸ”ŒAvailable MCP Tools
65
+ When connected to Claude Desktop, this server exposes **4 specific tools** that allow the Agent to perform the full archaeological pipeline:
66
 
67
+ #### `detect glyphs`
68
+ * **Description:** Scans an input image to find hieroglyphs.
69
+ * **Returns:** A path to the annotated image (boxes drawn) and a JSON object containing the list of found codes and confidence scores.
70
 
71
+ #### `translate story`
72
+ * **Description:** Takes a list of Gardiner codes or keywords and interprets them.
73
+ * **Returns:** Two distinct texts: a "Mystical Story" (creative interpretation) and an "Academic Translation" (scientific interpretation).
74
 
75
+ #### `get stats`
76
+ * **Description:** Takes the detection data and generates visual reports.
77
+ * **Returns:** A path to an image file containing charts for Symbol Frequency, Confidence Levels, and Spatial Heatmaps.
78
 
79
+ #### `list codes`
80
+ * **Description:** Provides access to the full internal database of Egyptian hieroglyphs.
81
+ * **Returns:** The complete dictionary of supported Gardiner codes, descriptions, and categories.
82
 
83
  ## πŸš€ How to Use (Claude Desktop)
84
 
 
97
  ```
98
  {
99
  "mcpServers": {
100
+ "gradio": {
101
+ "command": "npx",
102
  "args": [
103
  "mcp-remote",
104
+ "https://mcp-1st-birthday-rosetta-decoder.hf.space/gradio_api/mcp/",
105
  "--transport",
106
  "streamable-http"
107
  ]
108
  },
109
  "upload_helper": {
110
+ "command": "C:\\Python313\\python.exe",
111
  "args": [
112
  "-m",
113
  "gradio",
114
  "upload-mcp",
115
+ "https://mcp-1st-birthday-rosetta-decoder.hf.space/",
116
+ "C:\\Claude_Work"
117
  ]
118
  }
119
  }
 
124
 
125
  ## 🧩 Technical Architecture
126
 
127
+ - **Framework:** Gradio 6.0.0 (with native MCP support)
128
  - **Model:** Ultralytics YOLOv8 (Private Weights)
129
  - **Storage:** Hugging Face Hub (Private Repo for Model, Public Space for Inference)
130
  - **Protocol:** Model Context Protocol (MCP) via SSE (Server-Sent Events)