Skip to content

Commit 34960ea

Browse files
committed
update the README for MCP
1 parent a8b59c9 commit 34960ea

File tree

1 file changed

+176
-2
lines changed

1 file changed

+176
-2
lines changed

README.md

Lines changed: 176 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ A production-ready Next.js template featuring authentication, dark mode support,
77
![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)
88
![Tailwind](https://img.shields.io/badge/Tailwind-3.0-38B2AC)
99

10-
📹 Full Video Guide: [youtube link](https://www.youtube.com/watch?v=ad1BxZufer8&list=PLE9hy4A7ZTmpGq7GHf5tgGFWh2277AeDR&index=8)
10+
📹 Full YouTube Guide: [Youtube link](https://www.youtube.com/watch?v=ad1BxZufer8&list=PLE9hy4A7ZTmpGq7GHf5tgGFWh2277AeDR&index=8)
11+
12+
🚀 X Post: [X link](https://x.com/ShenSeanChen/status/1895163913161109792)
13+
14+
💡 Try the App: [App link](https://mvp.seanchen.io)
1115

1216
☕️ Buy me a coffee: [Cafe Latte](https://buy.stripe.com/5kA176bA895ggog4gh)
1317

@@ -22,6 +26,7 @@ A production-ready Next.js template featuring authentication, dark mode support,
2226
- 🛡️ TypeScript support
2327
- 📊 Error boundary implementation
2428
- 🔍 SEO optimized
29+
- 🤖 MCP integration for AI-powered development
2530

2631
## 🚀 Getting Started
2732

@@ -159,6 +164,169 @@ yarn dev
159164

160165
8. Open [http://localhost:3000](http://localhost:3000) in your browser.
161166

167+
## 🛠️ MCP Integration Setup
168+
169+
### What is MCP?
170+
171+
MCP (Model Control Protocol) enables enhanced AI assistant capabilities for this project, allowing the AI to interact directly with your Stripe and Supabase accounts to help with debugging, configuring, and managing your application.
172+
173+
For a comprehensive demonstration of MCP capabilities, check out our dedicated demo repository:
174+
- 🔗 [launch-mcp-demo](https://github.com/ShenSeanChen/launch-mcp-demo) - Collection of powerful MCP tools
175+
- 📹 [Full YouTube Guide](https://www.youtube.com/watch?v=sfCBCyNyw7U&list=PLE9hy4A7ZTmpGq7GHf5tgGFWh2277AeDR&index=10)
176+
- 🚀 [X Post](https://x.com/ShenSeanChen/status/1910057838032097688)
177+
178+
### Setting up MCP
179+
180+
1. Create an `mcp.json` file:
181+
182+
Copy the example file to create your own configuration:
183+
184+
```bash
185+
cp .cursor/mcp.json.example .cursor/mcp.json
186+
```
187+
188+
2. Configure your credentials:
189+
190+
a. Stripe Integration:
191+
- Get your Stripe API key from the Stripe Dashboard
192+
- Replace `your_stripe_test_key_here` with your actual test key
193+
194+
b. Supabase Integration:
195+
- Generate a Supabase access token from your Supabase dashboard (Project Settings > API)
196+
- Replace `your_supabase_access_token_here` with your actual token
197+
198+
c. GitHub Integration (optional):
199+
- Create a GitHub Personal Access Token with appropriate permissions
200+
- Replace `your_github_personal_access_token_here` with your actual token
201+
202+
3. Example of a completed `mcp.json` file:
203+
204+
```json
205+
{
206+
"mcpServers": {
207+
"stripe": {
208+
"command": "npx",
209+
"args": [
210+
"-y",
211+
"@stripe/mcp"
212+
],
213+
"env": {
214+
"STRIPE_SECRET_KEY": "sk_test_51ABC123..."
215+
}
216+
},
217+
"supabase": {
218+
"command": "npx",
219+
"args": [
220+
"-y",
221+
"@supabase/mcp-server-supabase@latest",
222+
"--access-token",
223+
"sbp_1234abcd5678efgh..."
224+
]
225+
}
226+
}
227+
}
228+
```
229+
230+
4. Using MCP with AI assistants:
231+
232+
After configuring `mcp.json`, the AI assistant within the Cursor editor will be able to:
233+
- Query and manage your Stripe subscriptions
234+
- Interact with your Supabase database
235+
- Help troubleshoot integration issues
236+
- Provide contextual help based on your actual configuration
237+
238+
5. Security Considerations:
239+
240+
- Never commit your `mcp.json` file to version control
241+
- Use test credentials during development
242+
- Limit access tokens to only the permissions needed
243+
244+
### Extending MCP with Additional Tools
245+
246+
The MCP framework can be extended with various tools beyond Stripe and Supabase. Our [launch-mcp-demo](https://github.com/ShenSeanChen/launch-mcp-demo) repository demonstrates how to integrate basic MCP examples.
247+
248+
To integrate these additional tools with your project:
249+
250+
1. Clone the demo repository:
251+
```bash
252+
git clone https://github.com/ShenSeanChen/launch-mcp-demo.git
253+
```
254+
255+
2. Follow the installation instructions in the repository's README
256+
257+
3. Update your `.cursor/mcp.json` to include the additional tools:
258+
```json
259+
{
260+
"mcpServers": {
261+
"stripe": {
262+
// Your existing Stripe configuration
263+
},
264+
"supabase": {
265+
// Your existing Supabase configuration
266+
},
267+
"weather": {
268+
"command": "/path/to/your/python/environment",
269+
"args": [
270+
"--directory",
271+
"/path/to/launch-mcp-demo/weather",
272+
"run",
273+
"weather.py"
274+
]
275+
},
276+
"files": {
277+
"command": "/path/to/your/python/environment",
278+
"args": [
279+
"--directory",
280+
"/path/to/launch-mcp-demo/files",
281+
"run",
282+
"files.py"
283+
]
284+
}
285+
}
286+
}
287+
```
288+
289+
4. Restart your Cursor editor to apply the changes
290+
291+
These additional tools can help enhance your development workflow and provide more capabilities to the AI assistant when working with your project.
292+
293+
### Claude Desktop Integration
294+
295+
If you're using Claude Desktop instead of Cursor editor, you can also integrate MCP tools by creating a configuration file at:
296+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
297+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
298+
- Linux: `~/.config/Claude/claude_desktop_config.json`
299+
300+
Example configuration for Claude Desktop:
301+
302+
```json
303+
{
304+
"mcpServers": {
305+
"stripe": {
306+
"command": "npx",
307+
"args": [
308+
"-y",
309+
"@stripe/mcp"
310+
],
311+
"env": {
312+
"STRIPE_SECRET_KEY": "your_stripe_test_key_here"
313+
}
314+
},
315+
"supabase": {
316+
"command": "npx",
317+
"args": [
318+
"-y",
319+
"@supabase/mcp-server-supabase@latest",
320+
"--access-token",
321+
"your_supabase_access_token_here"
322+
]
323+
}
324+
}
325+
}
326+
```
327+
328+
For more detailed instructions on Claude Desktop integration, check our [launch-mcp-demo repository](https://github.com/ShenSeanChen/launch-mcp-demo).
329+
162330
## 📖 Project Structure
163331

164332
```
@@ -182,7 +350,10 @@ yarn dev
182350
├── utils/ # Utility functions
183351
├── types/ # TypeScript type definitions
184352
├── public/ # Static assets
185-
└── styles/ # Global styles
353+
├── styles/ # Global styles
354+
└── .cursor/ # Cursor editor and MCP configurations
355+
├── mcp.json.example # Example MCP configuration
356+
└── mcp.json # Your custom MCP configuration (gitignored)
186357
```
187358
188359
## 🛠️ Built With
@@ -239,6 +410,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
239410
- Tailwind CSS team for the utility-first CSS framework
240411
- Supabase team for the backend platform
241412
- Stripe team for the payment infrastructure
413+
- Cursor team for the AI-powered editor and MCP capabilities
414+
- Anthropic for Claude AI and Claude Desktop integration
415+
- MCP framework developers for enabling extended AI capabilities
242416
243417
## 📫 Contact
244418

0 commit comments

Comments
 (0)