Skip to content

Commit bbd38f2

Browse files
authored
Merge pull request #8 from NicholasGoh/docs/add-video-assets-to-readme
Docs/add video assets to readme
2 parents 6f074d1 + 82a7fba commit bbd38f2

File tree

5 files changed

+134
-2
lines changed

5 files changed

+134
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FastAPI MCP LangGraph Template
22

3+
Read the docs with demo videos [here](https://nicholas-goh.com/docs/intro?ref=fastapi-mcp-langgraph-template).
4+
35
<!--toc:start-->
46
- [FastAPI MCP LangGraph Template](#fastapi-mcp-langgraph-template)
57
- [Core Features](#core-features)
@@ -10,6 +12,9 @@
1012
- [VSCode Devcontainer](#vscode-devcontainer)
1113
- [Without VSCode Devcontainer](#without-vscode-devcontainer)
1214
- [Refactored Markdown Files](#refactored-markdown-files)
15+
- [MCP](#mcp)
16+
- [Supabase](#supabase)
17+
- [Debugging](#debugging)
1318
<!--toc:end-->
1419

1520
## Core Features
@@ -90,6 +95,8 @@ docker compose up -d
9095

9196
## Development
9297

98+
First, set environment variables as per above.
99+
93100
### VSCode Devcontainer
94101

95102
> [!WARNING]
@@ -125,5 +132,18 @@ docker compose -f compose-dev.yaml up -d
125132

126133
The following markdown files provide additional details on other features:
127134

128-
- [`./docs/mcp.md`](./docs/mcp.md)
129-
- [`./docs/supabase.md`](./docs/supabase.md)
135+
### MCP
136+
137+
[`./docs/mcp.md`](./docs/mcp.md)
138+
139+
### Supabase
140+
141+
[`./docs/supabase.md`](./docs/supabase.md)
142+
143+
## Debugging
144+
145+
Sometimes in development, nginx reverse proxy needs to reload its config to route services properly.
146+
147+
```bash
148+
docker compose -f compose-dev.yaml exec nginx sh -c "nginx -s reload"
149+
```

docs/assets/mcps.mp4

2.98 MB
Binary file not shown.

docs/assets/supabase.mp4

4.28 MB
Binary file not shown.

docs/mcp.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# MCPs
2+
3+
[![MCP Client](https://img.shields.io/github/stars/modelcontextprotocol/python-sdk?logo=modelcontextprotocol&label=MCP-Client)](https://github.com/modelcontextprotocol/python-sdk) [![MCP Server](https://img.shields.io/github/stars/modelcontextprotocol/servers?logo=modelcontextprotocol&label=MCP-Servers)](https://github.com/modelcontextprotocol/servers)
4+
5+
<!--toc:start-->
6+
- [MCPs](#mcps)
7+
- [Video Demo](#video-demo)
8+
- [Key Features](#key-features)
9+
- [Inspector](#inspector)
10+
- [Community MCPs](#community-mcps)
11+
- [DBHub](#dbhub)
12+
- [Youtube](#youtube)
13+
- [Custom MCP](#custom-mcp)
14+
<!--toc:end-->
15+
16+
> MCP is an open protocol that standardizes how applications provide context to LLMs. Think of MCP like a USB-C port for AI applications. Just as USB-C provides a standardized way to connect your devices to various peripherals and accessories, MCP provides a standardized way to connect AI models to different data sources and tools.
17+
18+
Learn more [here](https://modelcontextprotocol.io/introduction).
19+
20+
## Video Demo
21+
22+
![mcps](./assets/mcps.mp4)
23+
24+
## Key Features
25+
26+
> MCP helps you build agents and complex workflows on top of LLMs. LLMs frequently need to integrate with data and tools, and MCP provides:
27+
> - A growing list of pre-built integrations that your LLM can directly plug into
28+
> - The flexibility to switch between LLM providers and vendors
29+
> - Best practices for securing your data within your infrastructure
30+
31+
## Inspector
32+
33+
Explore community and your custom MCP servers via Inspector at [http://localhost:6274](http://localhost:6274) in [Development](../README.md#development).
34+
35+
Left Sidebar:
36+
37+
- Select SSE `Transport Type`
38+
- Input `http://<mcp server>:<MCP_SERVER_PORT>/sse` in `URL`
39+
- Click `Connect`
40+
41+
Explore the following tabs in the Top Navbar:
42+
43+
- `Resources`
44+
- `Prompts`
45+
- `Tools`.
46+
47+
## Community MCPs
48+
49+
Before building your own custom MCP, explore the growing list of hundreds of [community MCPs](https://github.com/modelcontextprotocol/servers). With integrations spanning databases, cloud services, and web resources, the perfect fit might already exist.
50+
51+
### DBHub
52+
53+
Learn more [here](https://github.com/bytebase/dbhub). Explore more in [Inspector](#inspector).
54+
55+
Easily plug in this MCP into LLM to allow LLM to:
56+
57+
- Perform read-only SQL query validation for secure operations
58+
- Enable deterministic introspection of DB
59+
- List schemas
60+
- List tables in schemas
61+
- Retrieve table structures
62+
- Enrich user queries deterministically
63+
- Ground DB related queries with DB schemas
64+
- Provide SQL templates for translating natural language to SQL
65+
66+
### Youtube
67+
68+
Learn more [here](https://github.com/Klavis-AI/klavis/tree/main/mcp_servers/youtube). Explore more in [Inspector](#inspector).
69+
70+
Instead of building logic to:
71+
72+
- Scrape YouTube content
73+
- Adapt outputs for LLM compatibility
74+
- Validate tool invocation by the LLM
75+
- Chain these steps to fetch transcripts from URLs
76+
77+
Simply plug in this MCP to enable LLM to:
78+
79+
- Fetch transcripts from any YouTube URL on demand
80+
81+
## Custom MCP
82+
83+
Should you require a custom MCP, a template is provided [here](https://github.com/NicholasGoh/fastapi-mcp-langgraph-template/blob/main/backend/shared_mcp/tools.py) for you to reference in development.

docs/supabase.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Supabase
2+
3+
[![Supabase](https://img.shields.io/github/stars/supabase/supabase?logo=supabase&label=Supabase)](https://github.com/supabase/supabase)
4+
5+
<!--toc:start-->
6+
- [Supabase](#supabase)
7+
- [Video Demo](#video-demo)
8+
- [Features](#features)
9+
<!--toc:end-->
10+
11+
12+
## Video Demo
13+
14+
The start of the video shows how you can get your `POSTGRES_DSN` URL.
15+
16+
![Supabase](./assets/supabase.mp4)
17+
18+
## Features
19+
20+
Visit [here](https://supabase.com/) for a full list of features and learn more.
21+
22+
- Postgres Relational Database
23+
- Authentication
24+
- User Sign up and Login
25+
- Row and Column Security
26+
- Data APIs
27+
- Auto Generated from Table Schema
28+
- Self Host for free
29+
- Free Cloud usage for rapid prototyping

0 commit comments

Comments
 (0)