RReyesp commited on
Commit
93fbb1c
·
1 Parent(s): 8f97c92

docs: add track tag, team section, and how-to-use guide

Browse files
Files changed (1) hide show
  1. README.md +57 -0
README.md CHANGED
@@ -6,6 +6,8 @@ colorTo: blue
6
  sdk: static
7
  app_file: index.html
8
  pinned: false
 
 
9
  ---
10
 
11
  # Sentiment Evolution Tracker – MCP Monitoring Stack
@@ -33,6 +35,44 @@ A demo video (3-4 minutes) is included with the hackathon submission showing:
33
 
34
  ---
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  ## Installation
37
 
38
  ```powershell
@@ -112,3 +152,20 @@ Restart Claude Desktop after editing the file. Once connected, the seven tools a
112
  - ✅ Tests for the `save_analysis` workflow (`tests/test_save_analysis.py`)
113
 
114
  Run `python tools\dashboard.py` or open the generated HTML report to verify data before your demo, then start the MCP server and launch Claude Desktop to show the agentic workflow in real time.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  sdk: static
7
  app_file: index.html
8
  pinned: false
9
+ tags:
10
+ - building-mcp-track-01
11
  ---
12
 
13
  # Sentiment Evolution Tracker – MCP Monitoring Stack
 
35
 
36
  ---
37
 
38
+ ## How to Use
39
+
40
+ ### Quick Start (5 minutes)
41
+
42
+ 1. **Clone and install:**
43
+ ```powershell
44
+ git clone https://github.com/RubenReyesss/mcp-nlp-analytics.git
45
+ cd mcp-nlp-server
46
+ pip install -r requirements.txt
47
+ python -m textblob.download_corpora
48
+ python -m nltk.downloader punkt averaged_perceptron_tagger
49
+ ```
50
+
51
+ 2. **Populate demo data:**
52
+ ```powershell
53
+ python init_db.py
54
+ python tools/populate_demo_data.py
55
+ ```
56
+
57
+ 3. **View dashboard:**
58
+ ```powershell
59
+ python tools/dashboard.py
60
+ ```
61
+
62
+ 4. **Generate HTML report:**
63
+ ```powershell
64
+ python tools/generate_report.py
65
+ # Opens data/reporte_clientes.html in your browser
66
+ ```
67
+
68
+ 5. **Integrate with Claude Desktop:**
69
+ - Edit `config/claude_desktop_config.json` with your actual path
70
+ - Restart Claude Desktop
71
+ - Start the MCP server: `python src/mcp_server.py`
72
+ - Now Claude can access all 7 sentiment analysis tools
73
+
74
+ ---
75
+
76
  ## Installation
77
 
78
  ```powershell
 
152
  - ✅ Tests for the `save_analysis` workflow (`tests/test_save_analysis.py`)
153
 
154
  Run `python tools\dashboard.py` or open the generated HTML report to verify data before your demo, then start the MCP server and launch Claude Desktop to show the agentic workflow in real time.
155
+
156
+ ---
157
+
158
+ ## Team
159
+
160
+ | Role | Contributor | GitHub |
161
+ |------|-------------|--------|
162
+ | **Developer** | RubenReyesss | [@RubenReyesss](https://github.com/RubenReyesss) |
163
+
164
+ ---
165
+
166
+ ## Track
167
+
168
+ This project is submitted to **Track 1: Building MCPs** (`building-mcp-track-01`).
169
+
170
+ It demonstrates a production-ready MCP server that extends Claude's capabilities with persistent analytics, risk prediction, and alerting—solving the limitation that Claude lacks memory, database writes, and automated monitoring.
171
+