APPS_OVERVIEW.mdā¢8.73 kB
# š MCP ChatGPT Apps - Complete Overview
You now have **TWO** fully functional MCP ChatGPT Apps in this project!
---
## š App #1: Stock Market Top Movers
### What It Does
Displays real-time stock market data for top gainers, losers, and most actively traded stocks.
### Quick Start
```bash
./start.sh
# Opens on http://localhost:3000
```
### Features
- š Top Gainers table
- š Top Losers table
- š„ Most Actively Traded table
- š Adjustable result limits
- šØ Beautiful dark mode UI
- š± Responsive design
### MCP Tools
- `topMovers(limit)` - Get top stock movers
### API Used
- Alpha Vantage API (requires free API key)
### Documentation
- **START_HERE.md** - Main overview
- **QUICKSTART.md** - 3-step quick start
- **README.md** - Full documentation
- **ARCHITECTURE.md** - Technical details
### Files
- `src/server.ts` - MCP server
- `public/index.html` - Frontend
- `./start.sh` - Startup script
- Port: **3000**
---
## š± App #2: Currency Converter
### What It Does
Converts between 160+ currencies with real-time exchange rates.
### Quick Start
```bash
./start-currency.sh
# Opens on http://localhost:3001
```
### Features
- š± Real-time currency conversion
- š Auto-convert as you type
- š Live exchange rates table
- ā” Popular currency pairs
- šØ Beautiful dark mode UI
- š± Responsive design
- š No API key required!
### MCP Tools
- `convertCurrency(from, to, amount)` - Convert currencies
- `getSupportedCurrencies()` - List all currencies
- `getExchangeRates(base)` - Get all rates for base currency
### API Used
- exchangerate-api.com (free tier: 1500 req/month, no key needed)
### Documentation
- **CURRENCY_README.md** - Full documentation
- **CURRENCY_QUICKSTART.md** - Quick start guide
### Files
- `src/currency-server.ts` - MCP server
- `public-currency/index.html` - Frontend
- `./start-currency.sh` - Startup script
- Port: **3001**
---
## šÆ Both Apps Share
### Common Features
ā
**MCP SDK Integration** - Uses `@modelcontextprotocol/sdk`
ā
**Express REST API** - Clean REST endpoints
ā
**ChatGPT Integration** - `window.openai.callTool()` support
ā
**Auto-load** - Data loads automatically on page open
ā
**Dark Mode UI** - DaisyUI + Tailwind CSS
ā
**Smooth Animations** - Anime.js animations
ā
**Responsive Design** - Mobile-friendly
ā
**Error Handling** - Graceful error messages
ā
**TypeScript** - Type-safe code
ā
**Helper Scripts** - Easy startup
ā
**Complete Docs** - Comprehensive documentation
### Common Dependencies
- TypeScript
- Express.js
- @modelcontextprotocol/sdk
- Axios
- CORS
- DaisyUI
- Tailwind CSS
- Anime.js
---
## š Quick Start Both Apps
### Start Stock Market App
```bash
export ALPHA_VANTAGE_API_KEY=your_key_here
./start.sh
# http://localhost:3000
```
### Start Currency Converter
```bash
./start-currency.sh
# http://localhost:3001
```
### Run Both Simultaneously
**Terminal 1:**
```bash
./start.sh
```
**Terminal 2:**
```bash
./start-currency.sh
```
Now you have both apps running!
- Stock Market: http://localhost:3000
- Currency: http://localhost:3001
---
## š Project Structure
```
MCPAddIn/
āāā š Documentation
ā āāā APPS_OVERVIEW.md ā You are here!
ā āāā START_HERE.md ā Stock app overview
ā āāā QUICKSTART.md ā Stock app quick start
ā āāā README.md ā Stock app full docs
ā āāā ARCHITECTURE.md ā Technical architecture
ā āāā SETUP_COMPLETE.md ā Setup guide
ā āāā CURRENCY_README.md ā Currency app docs
ā āāā CURRENCY_QUICKSTART.md ā Currency quick start
ā
āāā š» Source Code
ā āāā src/
ā ā āāā server.ts ā Stock market MCP server
ā ā āāā currency-server.ts ā Currency MCP server
ā āāā public/
ā ā āāā index.html ā Stock market frontend
ā āāā public-currency/
ā āāā index.html ā Currency frontend
ā
āāā š ļø Scripts
ā āāā start.sh ā Start stock app
ā āāā start-currency.sh ā Start currency app
ā āāā ngrok.sh ā Expose stock app
ā āāā test-setup.sh ā Verify setup
ā
āāā š§ Configuration
ā āāā package.json ā Dependencies & scripts
ā āāā tsconfig.json ā TypeScript config
ā āāā env.example ā Environment variables
ā
āāā š¦ Build Output
āāā dist/
āāā server.js ā Compiled stock server
āāā currency-server.js ā Compiled currency server
```
---
## š Expose with ngrok
### Stock Market App
```bash
ngrok http 3000
```
### Currency Converter
```bash
ngrok http 3001
```
---
## š API Endpoints Comparison
### Stock Market App (Port 3000)
| Endpoint | Method | Description |
|----------|--------|-------------|
| / | GET | Stock market UI |
| /mcp/tools/list | GET | List tools |
| /mcp/tools/call | POST | Call topMovers tool |
### Currency Converter (Port 3001)
| Endpoint | Method | Description |
|----------|--------|-------------|
| / | GET | Currency converter UI |
| /mcp/tools/list | GET | List tools |
| /mcp/tools/call | POST | Call currency tools |
---
## šØ MCP Tools Summary
### Stock Market App
**Tool:** `topMovers`
```javascript
await window.openai.callTool('topMovers', { limit: 10 });
```
**Returns:**
```json
{
"top_gainers": [...],
"top_losers": [...],
"most_actively_traded": [...]
}
```
### Currency Converter
**Tool 1:** `convertCurrency`
```javascript
await window.openai.callTool('convertCurrency', {
from: 'USD',
to: 'EUR',
amount: 100
});
```
**Returns:**
```json
{
"from": "USD",
"to": "EUR",
"amount": 100,
"result": 92.50,
"rate": 0.925
}
```
**Tool 2:** `getSupportedCurrencies`
```javascript
await window.openai.callTool('getSupportedCurrencies', {});
```
**Tool 3:** `getExchangeRates`
```javascript
await window.openai.callTool('getExchangeRates', { base: 'USD' });
```
---
## š Environment Variables
### Stock Market App
```bash
export ALPHA_VANTAGE_API_KEY=your_key_here # Required
export PORT=3000 # Optional
```
### Currency Converter
```bash
export EXCHANGE_RATE_API_KEY=your_key_here # Optional
export PORT=3001 # Optional
```
---
## š ļø Development Commands
### Build Both Apps
```bash
npm run build
```
### Development Mode
**Stock Market:**
```bash
npm run dev
```
**Currency Converter:**
```bash
npm run dev-currency
```
### Production Mode
**Stock Market:**
```bash
npm start
```
**Currency Converter:**
```bash
npm start-currency
```
---
## šÆ Use Cases
### Stock Market App
- Track market performance
- Monitor top gainers/losers
- Find trading opportunities
- Market research
- Financial dashboards
### Currency Converter
- Travel planning
- International business
- E-commerce pricing
- Financial calculations
- Currency exchange
---
## š App Comparison
| Feature | Stock Market | Currency |
|---------|-------------|----------|
| **API Key Required** | ā
Yes | ā No (optional) |
| **Free Tier** | 5 req/min | 1500 req/month |
| **Auto-load** | ā
Yes | ā
Yes |
| **MCP Tools** | 1 | 3 |
| **Port** | 3000 | 3001 |
| **Data Type** | Stock prices | Exchange rates |
| **Update Frequency** | On demand | Real-time |
---
## š Documentation Navigation
### For Stock Market App
1. **START_HERE.md** - Overview
2. **QUICKSTART.md** - Quick start
3. **README.md** - Full docs
4. **ARCHITECTURE.md** - Technical details
### For Currency Converter
1. **CURRENCY_QUICKSTART.md** - Quick start
2. **CURRENCY_README.md** - Full docs
### For Both Apps
1. **APPS_OVERVIEW.md** - This file!
2. **SETUP_COMPLETE.md** - Setup guide
---
## š You're All Set!
You now have TWO production-ready MCP ChatGPT Apps:
1. **Stock Market Dashboard** - Track market movers
2. **Currency Converter** - Convert 160+ currencies
Both apps:
- ā
Use MCP SDK
- ā
Auto-load with `window.openai.callTool()`
- ā
Have beautiful responsive UIs
- ā
Are fully documented
- ā
Are ready to deploy
---
## š Next Steps
1. **Try the Stock App**: `./start.sh` ā http://localhost:3000
2. **Try the Currency App**: `./start-currency.sh` ā http://localhost:3001
3. **Run Both**: Start in separate terminals
4. **Expose with ngrok**: Share with the world!
5. **Customize**: Edit HTML/CSS to match your style
6. **Add More Tools**: Extend with additional MCP tools
---
**Happy Building! šš±**