youkii-xr commited on
Commit
4727fcb
Β·
verified Β·
1 Parent(s): f6fedbb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +84 -1
README.md CHANGED
@@ -11,4 +11,87 @@ short_description: Detect and classify hieroglyphs to its Gardiner code
11
  tags:
12
  - building-mcp-track-creative
13
  - mcp-server
14
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
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.