nothingworry commited on
Commit
e3ebaba
·
1 Parent(s): 29116ed

update the readme files

Browse files
Files changed (1) hide show
  1. backend/README.md +4 -3
backend/README.md CHANGED
@@ -46,7 +46,7 @@ cp env.example .env # update MCP URLs + LLM settings
46
  - `rag.ingest` - Ingest text content into knowledge base
47
  - `rag.delete` - Delete individual or all documents for a tenant
48
  - `rag.list` - List all documents for a tenant with pagination
49
- - `web.search` - DuckDuckGo-based web search
50
  - `admin.getRules`, `admin.addRule`, `admin.deleteRule`, `admin.logViolation`
51
 
52
  **HTTP Endpoints** (for direct API access):
@@ -149,7 +149,7 @@ Use the helper scripts in the repo root when validating backend changes:
149
  Defined in `env.example`:
150
 
151
  - `RAG_MCP_URL` - Default: `http://localhost:8900/rag` (unified MCP server)
152
- - `WEB_MCP_URL` - Default: `http://localhost:8900/web` (unified MCP server)
153
  - `ADMIN_MCP_URL` - Default: `http://localhost:8900/admin` (unified MCP server)
154
  - `MCP_PORT` - Port for unified MCP server (default: 8900)
155
  - `MCP_HOST` - Host for unified MCP server (default: 0.0.0.0)
@@ -158,6 +158,7 @@ Defined in `env.example`:
158
  - `SUPABASE_URL`, `SUPABASE_SERVICE_KEY` - **Required for Supabase backend** (admin rules + analytics)
159
  - If not set, the system automatically falls back to SQLite in `data/` directory
160
  - See `SUPABASE_SETUP.md` in the root directory for detailed setup instructions
 
161
  - `APP_ENV`, `LOG_LEVEL`, `API_PORT`
162
 
163
  Update these before starting the servers to ensure the agent can reach every MCP endpoint and LLM runtime.
@@ -217,7 +218,7 @@ Agents that speak the Model Context Protocol should connect to the `integrachat`
217
  | `rag` | `ingest` | Chunk + store new knowledge | `POST /rag/ingest` |
218
  | `rag` | `list` | List all documents for tenant | `GET /rag/list?tenant_id={id}` |
219
  | `rag` | `delete` | Remove one/all stored documents | `DELETE /rag/delete/{id}?tenant_id={id}` or `DELETE /rag/delete-all?tenant_id={id}` |
220
- | `web` | `search` | DuckDuckGo English-biased search | `POST /web/search` |
221
  | `admin` | `getRules` | Fetch tenant governance rules (list or detailed) | `POST /admin/getRules` |
222
  | `admin` | `addRule` | Insert or update a rule | `POST /admin/addRule` |
223
  | `admin` | `deleteRule` | Remove a rule by text | `POST /admin/deleteRule` |
 
46
  - `rag.ingest` - Ingest text content into knowledge base
47
  - `rag.delete` - Delete individual or all documents for a tenant
48
  - `rag.list` - List all documents for a tenant with pagination
49
+ - `web.search` - Google Programmable Search (Custom Search API) web search
50
  - `admin.getRules`, `admin.addRule`, `admin.deleteRule`, `admin.logViolation`
51
 
52
  **HTTP Endpoints** (for direct API access):
 
149
  Defined in `env.example`:
150
 
151
  - `RAG_MCP_URL` - Default: `http://localhost:8900/rag` (unified MCP server)
152
+ - `WEB_MCP_URL` - Default: `http://localhost:8900/web` (unified MCP server for Google web search)
153
  - `ADMIN_MCP_URL` - Default: `http://localhost:8900/admin` (unified MCP server)
154
  - `MCP_PORT` - Port for unified MCP server (default: 8900)
155
  - `MCP_HOST` - Host for unified MCP server (default: 0.0.0.0)
 
158
  - `SUPABASE_URL`, `SUPABASE_SERVICE_KEY` - **Required for Supabase backend** (admin rules + analytics)
159
  - If not set, the system automatically falls back to SQLite in `data/` directory
160
  - See `SUPABASE_SETUP.md` in the root directory for detailed setup instructions
161
+ - `GOOGLE_SEARCH_API_KEY`, `GOOGLE_SEARCH_CX_ID` - Credentials for Google Programmable Search used by `web.search`
162
  - `APP_ENV`, `LOG_LEVEL`, `API_PORT`
163
 
164
  Update these before starting the servers to ensure the agent can reach every MCP endpoint and LLM runtime.
 
218
  | `rag` | `ingest` | Chunk + store new knowledge | `POST /rag/ingest` |
219
  | `rag` | `list` | List all documents for tenant | `GET /rag/list?tenant_id={id}` |
220
  | `rag` | `delete` | Remove one/all stored documents | `DELETE /rag/delete/{id}?tenant_id={id}` or `DELETE /rag/delete-all?tenant_id={id}` |
221
+ | `web` | `search` | Google Programmable Search (Custom Search API) | `POST /web/search` |
222
  | `admin` | `getRules` | Fetch tenant governance rules (list or detailed) | `POST /admin/getRules` |
223
  | `admin` | `addRule` | Insert or update a rule | `POST /admin/addRule` |
224
  | `admin` | `deleteRule` | Remove a rule by text | `POST /admin/deleteRule` |