From 8c69cac93e5f3934e41a73244efd52ffb75d1125 Mon Sep 17 00:00:00 2001 From: Spaike Date: Fri, 8 May 2026 16:05:00 +0200 Subject: [PATCH] docs: rewrite README in English, remove internal security details - Full English translation - Removed Security and MCP vs Portal permissions sections - Updated tool list to include new tools (members, rfh_statistics, etc.) - Added new example questions --- README.md | 109 +++++++++++++++++++++++++----------------------------- 1 file changed, 50 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 3a4810e..2e0b8f5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Cauldron Cloud — MCP Server -Collega Claude Desktop (o qualsiasi client MCP) al portale Cauldron. +Connects Claude Desktop (or any MCP client) to the Cauldron M&A portal. -## Installazione rapida (3 comandi) +## Quick setup — 3 commands ```bash git clone https://git.zerotohero.it/Spaike/cauldron-mcp.git @@ -10,52 +10,52 @@ cd cauldron-mcp python setup.py ``` -Il wizard: -1. Installa le dipendenze automaticamente -2. Apre il browser sulla pagina API Keys del portale -3. Legge la chiave che incolli nel terminale -4. Scrive `claude_desktop_config.json` senza toccare le altre configurazioni +The wizard will: +1. Install dependencies automatically +2. Open the browser to the API Keys page on the portal +3. Read the key you paste into the terminal +4. Write `claude_desktop_config.json` without touching your other settings -Poi riavvia Claude Desktop — fatto. +Then restart Claude Desktop — done. --- -## Installazione manuale (alternativa) +## Manual setup -### Prerequisiti +### Requirements - Python 3.10+ - pip -### Dipendenze +### Install dependencies ```bash pip install mcp httpx ``` -### Ottenere la API Key +### Get your API key -Accedere al portale Cauldron → menu utente → **API Keys** → "Generate". -La chiave ha il formato: `cldrn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` +Go to the Cauldron portal → user menu → **API Keys** → click **Generate**. +Your key looks like: `cldrn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` -> La chiave viene mostrata **una sola volta**. Conservarla in modo sicuro. +> The key is shown **once only**. Store it somewhere safe. -### Configurazione Claude Desktop +### Configure Claude Desktop -Aprire il file di configurazione: +Open the config file: - **Mac**: `~/Library/Application Support/Claude/claude_desktop_config.json` - **Linux**: `~/.config/Claude/claude_desktop_config.json` - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` -Aggiungere la sezione `mcpServers`: +Add the `mcpServers` block: ```json { "mcpServers": { "cauldron": { "command": "python", - "args": ["/percorso/assoluto/cauldron-mcp/server.py"], + "args": ["/absolute/path/to/cauldron-mcp/server.py"], "env": { "CAULDRON_API_KEY": "cldrn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } @@ -64,55 +64,46 @@ Aggiungere la sezione `mcpServers`: } ``` -Riavviare Claude Desktop. +Restart Claude Desktop. -## Tool disponibili +--- -| Tool | Descrizione | +## Available tools + +| Tool | Description | |---|---| -| `get_my_profile` | Info sull'utente autenticato e la sua firma | -| `list_deals` | Lista deal con filtri (tipo, stage, industria, paese, testo libero) | -| `get_deal_detail` | Dettaglio completo di un deal | -| `deal_statistics` | Statistiche aggregate (per stage, industria, anno, ecc.) | -| `list_my_requests_for_help` | RFH inviati dalla mia firma al network | -| `list_incoming_requests` | RFH di altre firm diretti a noi (con filtro "senza risposta") | -| `list_deal_stages` | Elenco stage disponibili | -| `list_industries` | Elenco classificazioni industry | -| `list_firms` | Elenco firm visibili | +| `get_my_profile` | Your user profile and firm | +| `list_deals` | List deals with filters (type, stage, industry, country, free text) | +| `get_deal_detail` | Full detail of a single deal | +| `deal_statistics` | Aggregated stats grouped by stage, industry, year, month, country, etc. | +| `list_my_requests_for_help` | Requests for Help sent by your firm to the network | +| `list_incoming_requests` | Incoming RFH from other firms (filterable by unanswered) | +| `list_rfh_suggestions` | Suggestions submitted for a specific Request for Help | +| `rfh_statistics` | Aggregated RFH activity stats (response rates, top responders, etc.) | +| `list_members` | Network professionals (filter by sector, country, job title, firm) | +| `get_member_detail` | Full profile of a single network member | +| `list_deal_stages` | Available deal stages | +| `list_industries` | Industry classifications | +| `list_firms` | Firms visible to your account | -## Esempi di domande a Claude +--- + +## Example questions for Claude ``` -"Mostrami tutti i deal Sell Side ancora aperti nel settore Automotive" +"Show me all open Sell Side deals in the Automotive sector" -"Quanti deal abbiamo chiuso nel 2024 per industria?" +"How many deals did we close in 2024, broken down by industry?" -"Ci sono Request for Help a cui non abbiamo ancora risposto?" +"Are there any Requests for Help we haven't answered yet?" -"Dammi il dettaglio del deal #142" +"Give me the full detail of deal #142" -"Quali deal condivisi nel network riguardano il settore Technology?" +"What shared network deals are in the Technology sector?" -"Statistiche sui nostri deal per anno, dal 2022 ad oggi" +"Show deal statistics by month from 2023 to today" + +"Who in the network covers Healthcare deals in Germany?" + +"How is our firm performing on incoming Requests for Help?" ``` - -## Sicurezza - -- La API key identifica univocamente l'utente — trattarla come una password -- La visibilità è identica al portale web: solo i propri deal + quelli condivisi -- I deal cancellati non vengono mai restituiti -- I valori finanziari con flag di confidenzialità vengono mascherati automaticamente -- La chiave è revocabile in qualsiasi momento dal portale - -## Permessi MCP vs Portale - -| Aspetto | Portale web | MCP | -|---|---|---| -| Admin Portale vede tutti i deal | ✅ | ❌ (firma-scoped) | -| Deal propria firma | ✅ | ✅ | -| Deal condivisi altre firm | ✅ | ✅ | -| Deal cancellati (Attivo=N) | ❌ | ❌ | -| Valori confidenziali | Visibili se autorizzato | Mascherati | - -> Il layer MCP è intenzionalmente più restrittivo: nessun utente ottiene visibilità -> super-admin attraverso l'API key, indipendentemente dal proprio ruolo sul portale.