Quellcode durchsuchen

docs: align outlook with current news-mcp tools

Lukas Goldschmidt vor 1 Monat
Ursprung
Commit
001218d92d
1 geänderte Dateien mit 57 neuen und 5 gelöschten Zeilen
  1. 57 5
      OUTLOOK.md

+ 57 - 5
OUTLOOK.md

@@ -169,7 +169,8 @@ Input:
 ```json id="n1"
 {
   "topic": "crypto",
-  "limit": 5
+  "limit": 5,
+  "include_articles": false
 }
 ```
 
@@ -184,7 +185,15 @@ Output:
     "sentiment": "positive",
     "importance": 0.82,
     "sources": ["Reuters", "CoinDesk"],
-    "timestamp": "..."
+    "timestamp": "...",
+    "articles": [
+      {
+        "title": "...",
+        "url": "...",
+        "source": "Reuters",
+        "timestamp": "..."
+      }
+    ]
   }
 ]
 ```
@@ -197,12 +206,17 @@ Output:
 
 ```json id="n3"
 {
-  "entity": "BTC"
+  "entity": "BTC",
+  "include_articles": false
 }
 ```
 
 👉 filters clusters by entity
 
+Optional:
+
+* `include_articles` to include article title/url/source/timestamp in the payload
+
 ---
 
 ## 3. `get_event_summary`
@@ -211,7 +225,8 @@ Output:
 
 ```json id="n4"
 {
-  "event_id": "cluster_id"
+  "event_id": "cluster_id",
+  "include_articles": false
 }
 ```
 
@@ -220,6 +235,7 @@ Output:
 * merged summary
 * key facts
 * sources
+* optional articles (title/url/source/timestamp)
 
 👉 This is where you compress multiple articles into one clean narrative
 
@@ -259,13 +275,45 @@ Output:
   {
     "topic": "Ethereum ETF",
     "trend_score": 0.91,
-    "related_entities": ["ETH"]
+    "related_entities": ["ETH", "BlackRock", "SEC"],
+    "count": 8,
+    "avg_importance": 0.17
   }
 ]
 ```
 
 ---
 
+## 6. `get_related_entities`
+
+> “What entities tend to appear with X?”
+
+```json id="n8"
+{
+  "subject": "Iran",
+  "timeframe": "24h",
+  "limit": 10
+}
+```
+
+Output:
+
+```json id="n9"
+[
+  {
+    "entity": "United States",
+    "count": 5,
+    "avg_importance": 0.11,
+    "sentiment": "negative",
+    "score": -0.2
+  }
+]
+```
+
+👉 entity-only co-occurrence neighborhood for real-time sense-making
+
+---
+
 # ⚠️ 3. What NOT to expose
 
 Avoid:
@@ -401,6 +449,10 @@ But only if you:
 * JSON-backed alias map added for query normalization
 * query normalization added so shorthand like `btc` and `trump` still works
 * docs updated with the new env vars and workflow
+* optional article payloads added to event tools
+* blacklist enforcement maintenance script added
+* related-entities tool added for co-occurrence neighborhoods
+* emerging-topic scoring improved with importance-weighting and co-occurrence
 
 ---