Skip to content

Commit 9aa9964

Browse files
committed
Readme update
1 parent 7a18308 commit 9aa9964

File tree

1 file changed

+126
-42
lines changed

1 file changed

+126
-42
lines changed

README.md

Lines changed: 126 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,68 @@
1-
# Deco MCP template app
1+
# Deco AI App Template
22

3-
A full-stack template for building
4-
[Model Context Protocol (MCP)](https://spec.modelcontextprotocol.io/) servers
5-
with a modern React frontend.
3+
**The fastest way to build AI-powered applications with instant access to thousands of APIs.**
64

7-
This template provides a complete development environment where your MCP server
8-
not only exposes tools and workflows to AI agents but also serves a beautiful
9-
web interface built with React and Tailwind CSS.
5+
This is the official template used when you run `npm create deco@latest` to bootstrap your AI application. Built on the [Model Context Protocol (MCP)](https://spec.modelcontextprotocol.io/), this template gives you everything you need to create powerful AI apps that can connect to any service, API, or data source.
6+
7+
## 🌟 What You Can Build
8+
9+
With this template, you can rapidly create AI applications that:
10+
11+
- **🔌 Connect to Thousands of APIs**: Instant integration with popular services like OpenAI, Stripe, SendGrid, databases, and more through MCP protocol
12+
- **🤖 AI-Native Tools**: Create intelligent tools that leverage AI for data processing, analysis, and automation
13+
- **⚡ Real-time Collaboration**: Build collaborative AI experiences with live updates and shared state
14+
- **🎨 Beautiful Interfaces**: Modern React frontend with Tailwind CSS and shadcn/ui components
15+
- **🚀 Production Ready**: Deploy instantly to Cloudflare Workers with global edge distribution
16+
17+
## 🔥 MCP Protocol Power
18+
19+
The Model Context Protocol enables your AI app to seamlessly connect with:
20+
- **External APIs** (REST, GraphQL, webhooks)
21+
- **Databases** (PostgreSQL, MySQL, MongoDB, and more)
22+
- **AI Services** (OpenAI, Anthropic, local models)
23+
- **Business Tools** (CRM, analytics, payment processors)
24+
- **Custom Integrations** (your own services and APIs)
25+
26+
All with **type-safe**, **auto-generated** client code and **zero configuration**.
1027

1128
## 📝 Development History
1229

1330
This repository uses [Specstory](https://specstory.com/) to track the history of
1431
prompts that were used to code this repo. You can inspect the complete
1532
development history in the [`.specstory/`](.specstory/) folder.
1633

17-
## ✨ Features
18-
19-
- **🤖 MCP Server**: Cloudflare Workers-based server with typed tools and
20-
workflows
21-
- **⚛️ React Frontend**: Modern React app with Vite, TanStack Router, and
22-
Tailwind CSS
23-
- **🎨 UI Components**: Pre-configured shadcn/ui components for rapid
24-
development
25-
- **🔧 Type Safety**: Full TypeScript support with auto-generated RPC client
26-
types
27-
- **🚀 Hot Reload**: Live development with automatic rebuilding for both
28-
frontend and backend
34+
## ✨ Template Features
35+
36+
- **🤖 MCP Server**: Cloudflare Workers-based server with typed AI tools
37+
- **⚛️ React Frontend**: Modern React app with Vite, TanStack Router, and Tailwind CSS
38+
- **🎨 UI Components**: Pre-configured shadcn/ui components for rapid development
39+
- **🔧 Type Safety**: Full TypeScript support with auto-generated RPC client types
40+
- **🚀 Hot Reload**: Live development with automatic rebuilding for both frontend and backend
2941
- **☁️ Ready to Deploy**: One-command deployment to Cloudflare Workers
42+
- **🔗 API Integrations**: Connect to thousands of services through deco marketplace
43+
- **🛡️ Built-in Auth**: OAuth integration with popular providers (Google, GitHub, etc.)
44+
- **🗄️ Integrated Database**: SQLite database with 10GB storage included in every project
3045

31-
## 🚀 Quick Start
46+
## 🚧 Coming Soon: Visual Workflow Editor
3247

33-
### Prerequisites
48+
We're finishing our **visual workflow editor** where you'll be able to:
49+
- **🎨 Drag & Drop**: Compose AI tools visually with an intuitive interface
50+
- **🤝 Real-time Collaboration**: Work together on workflows with your team
51+
- **🧠 AI-Generated Workflows**: Let AI help you build complex automation flows
52+
- **⚡ Live Preview**: See your workflows in action as you build them
3453

35-
- Node.js ≥22.0.0
54+
*This will revolutionize how you create AI-powered automation and data processing pipelines.*
55+
56+
## 🚀 Quick Start
3657

37-
### Setup
58+
### Create Your AI App
3859

3960
```bash
40-
# Install dependencies
41-
npm install
61+
# Create a new AI app from this template
62+
npm create deco@latest my-ai-app
63+
64+
# Navigate to your project
65+
cd my-ai-app
4266

4367
# Configure your app
4468
npm run configure
@@ -47,14 +71,30 @@ npm run configure
4771
npm run dev
4872
```
4973

50-
The server will start on `http://localhost:8787` serving both your MCP endpoints
51-
and the React frontend.
74+
The server will start on `http://localhost:8787` serving both your MCP endpoints and the React frontend.
75+
76+
### Prerequisites
77+
78+
- Node.js ≥22.0.0
79+
- [Deco CLI](https://docs.deco.page) installed for authentication
80+
- A [deco](https://admin.decocms.com/) account for API integrations
81+
82+
### ⚠️ Important Setup Note
83+
84+
To properly use this template, you need to:
85+
86+
1. **Deploy first**: Run `npm run deploy` or `bun run deploy` to create your app
87+
2. **Install Deco CLI**: Follow instructions at [docs.deco.page](https://docs.deco.page)
88+
3. **Login**: Use `deco login` to authenticate with your account
89+
90+
This is required for OAuth authentication and integration management to work properly.
5291

5392
## 📁 Project Structure
5493

5594
```
5695
├── server/ # MCP Server (Cloudflare Workers + Deco runtime)
57-
│ ├── main.ts # Server entry point with tools & workflows
96+
│ ├── main.ts # Server entry point with AI tools
97+
│ ├── tools/ # Domain-organized AI tools
5898
│ └── deco.gen.ts # Auto-generated integration types
5999
└── view/ # React Frontend (Vite + Tailwind CSS)
60100
├── src/
@@ -64,32 +104,76 @@ and the React frontend.
64104
└── package.json
65105
```
66106

67-
## 🛠️ Development Workflow
107+
## 🛠️ Development Commands
68108

69109
- **`npm run dev`** - Start development with hot reload
70-
- **`npm run gen`** - Generate types for external integrations
110+
- **`npm run gen`** - Generate types for external integrations
71111
- **`npm run deploy`** - Deploy to production
112+
- **`npm run configure`** - Configure your app and workspace
72113

73114
## 🔗 Frontend ↔ Server Communication
74115

75-
The template includes a fully-typed RPC client that connects your React frontend
76-
to your MCP server:
116+
The template includes a fully-typed RPC client that connects your React frontend to your MCP server:
77117

78118
```typescript
79-
// Typed calls to your server tools and workflows
80-
const result = await client.MY_TOOL({ input: "data" });
81-
const workflowResult = await client.MY_WORKFLOW({ input: "data" });
119+
// Typed calls to your AI tools
120+
const result = await client.MY_AI_TOOL({ input: "data" });
121+
const analysis = await client.ANALYZE_DATA({ dataset: data });
82122
```
83123

84-
## 📖 Learn More
124+
## 🌐 API Integration System
125+
126+
Connect to thousands of services instantly through your [deco project](https://admin.decocms.com/):
127+
128+
- **🤖 AI Services**: OpenAI, Anthropic, Cohere, local models
129+
- **💳 Payments**: Stripe, PayPal, Square
130+
- **📧 Communication**: SendGrid, Twilio, Slack
131+
- **🗄️ Databases**: PostgreSQL, MongoDB, Redis, Supabase
132+
- **📊 Analytics**: Google Analytics, Mixpanel, Segment
133+
- **And thousands more...**
134+
135+
### Adding Integrations
136+
137+
All apps installed in your [deco project](https://admin.decocms.com/) can be used to create new tools or views:
138+
139+
1. **Install apps** in your deco project dashboard
140+
2. **Run integration**: `npm run configure` or `bun run configure`
141+
3. **Auto-generated types**: MCP types are downloaded to `shared/deco.gen.ts`
142+
4. **Start building**: Use the typed clients in your tools immediately
143+
144+
All integrations come with auto-generated TypeScript types and zero-config setup.
85145

86-
This template is built for deploying primarily on top of the
87-
[Deco platform](https://decocms.com) which can be found at the
88-
[deco-cx/chat](https://github.com/deco-cx/chat) repository.
146+
## 🗄️ Integrated Database
89147

90-
Documentation can be found at [https://docs.deco.page](https://docs.deco.page)
148+
Every deco project includes a **SQLite database with 10GB storage**:
149+
150+
- **Zero setup**: Database is ready to use out of the box
151+
- **Type-safe ORM**: Built-in Drizzle ORM with TypeScript support
152+
- **Automatic migrations**: Schema changes are applied automatically
153+
- **Production ready**: Scales with your application needs
154+
155+
Perfect for storing user data, application state, and business logic without external database setup.
156+
157+
## 🎯 Example Use Cases
158+
159+
Build powerful AI applications like:
160+
161+
- **📊 Data Analysis Tools**: Connect to databases and APIs to analyze business data with AI
162+
- **🤖 Customer Support Bots**: Integrate with CRM and support systems for intelligent assistance
163+
- **📝 Content Generation**: Combine AI with content management systems and social media APIs
164+
- **💼 Business Automation**: Create workflows that connect multiple services and automate tasks
165+
- **🔍 Research Assistants**: Build tools that gather and analyze information from multiple sources
166+
- **📈 Analytics Dashboards**: Create AI-powered insights from your business data
167+
168+
## 📖 Resources
169+
170+
- **🚀 Get Started**: [Create your first AI app](https://decocms.com/)
171+
- **📚 Documentation**: [docs.deco.page](https://docs.deco.page)
172+
- **💬 Community**: [Join our Discord](https://discord.gg/deco)
173+
- **🐙 Source Code**: [deco-cx/deco](https://github.com/deco-cx/deco)
91174

92175
---
93176

94-
**Ready to build your next MCP server with a beautiful frontend?
95-
[Get started now!](https://admin.decocms.com)**
177+
**Ready to build the next generation of AI applications?**
178+
179+
[🚀 **Start Building Now**](https://decocms.com/)[📖 **Read the Docs**](https://docs.deco.page)[💬 **Join Community**](https://discord.gg/deco)

0 commit comments

Comments
 (0)