From be711eab13e2c0de35c6594568d1a0c6e61cdc12 Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Thu, 10 Apr 2025 17:50:51 -0700 Subject: [PATCH] doc: readme --- README.md | 15 +++++++++------ servers/get-user-info/README.md | 2 -- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e09d87b..91659e8 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,18 @@ docker compose up Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports. -## 📂 Server Examples +## 📂 Server Reference Implementations Reference implementations provided in this repository demonstrate common use-cases clearly and simply: -- **Filesystem Access** _(servers/filesystem)_ - Manage local file operations safely with configurable restrictions. -- **Git Server** _(servers/git)_ - Expose Git repositories for searching, reading, and possibly writing via controlled API endpoints. -- **WIP: Database Server** _(servers/database)_ - Query and inspect database schemas across common DB engines like PostgreSQL, MySQL, and SQLite. -- **Memory & Knowledge Graph** _(servers/memory)_ - Persistent memory management and semantic knowledge querying using popular and reliable storage techniques. -- **WIP: Web Search & Fetch** _(servers/web-search)_ - Retrieve and convert web-based content securely into structured API results usable by LLMs. +- [**Filesystem Access**](servers/filesystem) - Manage local file operations safely with configurable restrictions. +- [**Git Server**](servers/git) - Expose Git repositories for searching, reading, and possibly writing via controlled API endpoints. +- [**Memory & Knowledge Graph**](servers/memory) - Persistent memory management and semantic knowledge querying using popular and reliable storage techniques. +- [**Weather Server**](servers/weather) - Provide current weather conditions and forecasts from trusted public APIs. +- [**Get User Info Server**](servers/get-user-info) - Access and return enriched user profile information from authentication providers or internal systems. +- [**WIP: Web Search & Fetch**](servers/web-search) - Retrieve and convert web-based content securely into structured API results usable by LLMs. +- [**WIP: Database Server**](servers/database) - Query and inspect database schemas across common DB engines like PostgreSQL, MySQL, and SQLite. + (More examples and reference implementations will be actively developed and continually updated.) diff --git a/servers/get-user-info/README.md b/servers/get-user-info/README.md index 6a3cb8c..b701d99 100644 --- a/servers/get-user-info/README.md +++ b/servers/get-user-info/README.md @@ -56,8 +56,6 @@ curl -H "Authorization: Bearer " http://localhost:8000/get_user_info - Python 3.11+ - FastAPI ⚡ -- httpx 🌐 -- Uvicorn 🔥 ---