Skip to content

Commit 4352bd7

Browse files
fakepixelsfakepixels
committed
docs: enhance README with guidelines for extending Base MCP with new tools and protocols
1 parent 2924a09 commit 4352bd7

File tree

3 files changed

+217
-0
lines changed

3 files changed

+217
-0
lines changed

‎MCP ideas/MCP-use-cases.md

+157
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Real-World Use Cases for Base MCP
2+
3+
![Base MCP](../public/SendUSDC.gif)
4+
5+
## Introduction
6+
7+
Base MCP lets AI applications like Claude and Cursor interact with the Base Network and Coinbase API. Here are practical ways to use Base MCP for real applications.
8+
9+
**We provide grants to the most innovative use cases!** See the [Grants Program](#grants-program) section below.
10+
11+
## Table of Contents
12+
13+
- [Developer Use Cases](#developer-use-cases)
14+
- [Smart Contract Development](#smart-contract-development)
15+
- [Everyday Applications](#everyday-applications)
16+
- [DeFi Tools](#defi-tools)
17+
- [End-User Use Cases](#end-user-use-cases)
18+
- [Personal Finance](#personal-finance)
19+
- [Family & Friends](#family--friends)
20+
- [Shopping & Payments](#shopping--payments)
21+
- [Community Projects](#community-projects)
22+
- [Business Use Cases](#business-use-cases)
23+
- [Small Business Tools](#small-business-tools)
24+
- [Grants Program](#grants-program)
25+
26+
## Developer Use Cases
27+
28+
### Smart Contract Development
29+
30+
- **Simple Contract Deployment**: Create and deploy basic smart contracts by describing what you want in plain English. Base MCP handles the code generation and deployment.
31+
32+
- **Contract Function Caller**: Build a tool that lets you call any contract function on Base by just providing the address, function name, and parameters.
33+
34+
- **Token Creator**: Deploy your own ERC20 token on Base with custom name, symbol, and supply in minutes without writing code.
35+
36+
- **NFT Collection Launcher**: Create and deploy an NFT collection on Base by providing just the name, symbol, and metadata URI.
37+
38+
### Everyday Applications
39+
40+
- **P2P Payment Mini App**: Build a P2P payment app with Base MCP to make USDC transfer easy between friends across the globe. Try building it with [MiniKit](https://www.base.org/builders/minikit).
41+
42+
- **Group Expense Splitter**: Create an app that helps friends split bills and expenses using USDC on Base, with automatic settlement.
43+
44+
- **Subscription Manager**: Build a simple app to manage recurring payments for services using Base's low transaction fees.
45+
46+
- **Allowance Tracker**: Create a tool for parents to send weekly allowances to their kids' wallets on Base with spending controls.
47+
48+
- **Donation Button**: Add a simple "Donate" button to any website that accepts USDC on Base with minimal integration work.
49+
50+
### DeFi Tools
51+
52+
- **Morpho Vault Viewer**: Build a simple dashboard to check available Morpho vaults on Base and see current yields.
53+
54+
- **DeFi Position Manager**: Create a tool to deposit into and withdraw from Morpho vaults on Base with a simple interface.
55+
56+
- **Yield Comparison Tool**: Build an app that compares yields across different Base DeFi protocols to find the best returns.
57+
58+
- **Auto-Compound Helper**: Create a tool that automatically reinvests yield from Base DeFi protocols to maximize returns.
59+
60+
- **Simple Lending Dashboard**: Build a dashboard to track your lending positions on Base with alerts for important events.
61+
62+
## End-User Use Cases
63+
64+
### Personal Finance
65+
66+
- **Crypto Earning App**: Build a simple budgeting app that earns yield on USDC/Tokens on Base. You can use [OnchainKit's Earn component](https://onchainkit.xyz/)].
67+
68+
- **Savings Goals Tracker**: Create an app that helps users set savings goals and automatically moves funds to reach them.
69+
70+
- **Bill Payment Reminder**: Build a tool that reminds users of upcoming bills and helps them pay with USDC on Base.
71+
72+
- **Spare Change Saver**: Create an app that rounds up everyday purchases and saves the "spare change" in a Base DeFi vault.
73+
74+
- **Emergency Fund Builder**: Build a tool that helps users create and maintain an emergency fund in stablecoins on Base.
75+
76+
### Family & Friends
77+
78+
- **Family Wallet**: Create a shared wallet for families on Base with customizable permissions for different members.
79+
80+
- **Gift Card Sender**: Build an app to send USDC gift cards to friends and family on special occasions.
81+
82+
- **Chore Reward System**: Create a system for parents to reward kids for completing chores with small USDC payments on Base.
83+
84+
- **Group Trip Planner**: Build a tool for friends to pool funds for trips and automatically split expenses on Base.
85+
86+
- **Savings Challenge**: Create an app for friends to compete in savings challenges with automatic tracking on Base.
87+
88+
### Shopping & Payments
89+
90+
- **Quick Checkout Button**: Add a "Pay with Base" button to online stores for fast USDC payments.
91+
92+
- **Digital Product Store**: Build a simple marketplace for digital products with instant delivery after Base payment.
93+
94+
- **Tipping Tool**: Create a simple way for content creators to receive tips in USDC on Base.
95+
96+
- **Subscription Bundle**: Build a tool that lets users subscribe to multiple services with one Base payment.
97+
98+
- **Local Business Finder**: Create an app that helps users find and support local businesses that accept Base payments.
99+
100+
### Community Projects
101+
102+
- **Community Fund Pool**: Build a simple tool for neighborhoods to pool funds for local improvements on Base.
103+
104+
- **Transparent Charity**: Create a donation platform where all funds and distributions are tracked on Base for full transparency.
105+
106+
- **Crowdfunding Lite**: Build a basic crowdfunding platform with automatic fund release when goals are met on Base.
107+
108+
- **Volunteer Rewards**: Create a system to recognize and reward community volunteers with tokens on Base.
109+
110+
- **Local Event Tickets**: Build a simple ticketing system for community events using NFTs on Base.
111+
112+
## Business Use Cases
113+
114+
### Small Business Tools
115+
116+
- **Invoice Payment System**: Create a simple system for businesses to send invoices and receive payments in USDC on Base.
117+
118+
- **Employee Bonus Distribution**: Build a tool for distributing bonuses to employees using Base's low-fee transactions.
119+
120+
- **Vendor Payment Automation**: Create a system to automate payments to vendors when delivery is confirmed on Base.
121+
122+
- **Customer Loyalty Program**: Build a simple loyalty program for small businesses using tokens on Base.
123+
124+
- **Digital Gift Cards**: Create a system for businesses to sell and redeem digital gift cards on Base.
125+
126+
## Grants Program
127+
128+
Base supports innovative projects built using Base MCP. Our grants program provides funding, technical support, and marketing assistance to selected projects.
129+
130+
### Grant Categories
131+
132+
- **Developer Tools**: Projects that make it easier to build on Base
133+
- **End-User Apps**: Applications that bring new users to Base
134+
- **Business Solutions**: Projects solving real business needs on Base
135+
- **Educational Tools**: Projects that help people learn about Base
136+
137+
### Application Process
138+
139+
To apply for a grant, please tag @buildonbase when you share your project on X or Warpcast.
140+
141+
Your demo ideally includes:
142+
143+
1. Project description and use case
144+
2. Technical approach (How you leveraged Base MCP)
145+
3. Product roadmap + GTM approach
146+
147+
### Selection Criteria
148+
149+
Proposals will be evaluated based on:
150+
151+
- Innovation and creativity
152+
- Technical feasibility
153+
- Potential impact
154+
- Team capability
155+
- Alignment with Base's mission
156+
157+
Selected projects will be announced on our social media channels.

‎README.md

+60
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,53 @@ This MCP server extends any MCP client's capabilities by providing tools to do a
2323

2424
The server interacts with Base, powered by Base Developer Tools and [AgentKit](https://github.com/coinbase/agentkit).
2525

26+
## Extending Base MCP with 3P Protocols, Tools, and Data Sources
27+
28+
Base MCP is designed to be extensible, allowing you to add your own third-party protocols, tools, and data sources. This section provides an overview of how to extend the Base MCP server with new capabilities.
29+
30+
### Adding New Tools
31+
32+
If you want to add a new tool to the Base MCP server, follow these steps:
33+
34+
1. Create a new directory in the `src/tools` directory for your tool
35+
2. Implement the tool following the existing patterns:
36+
- `index.ts`: Define and export your tools
37+
- `schemas.ts`: Define input schemas for your tools
38+
- `handlers.ts`: Implement the functionality of your tools
39+
3. Add your tool to the list of available tools in `src/tools/index.ts`
40+
4. Add documentation for your tool in the README.md
41+
5. Add examples of how to use your tool in examples.md
42+
6. Write tests for your tool
43+
44+
### Project Structure
45+
46+
The Base MCP server follows this structure for tools:
47+
48+
```
49+
src/
50+
├── tools/
51+
│ ├── index.ts (exports toolsets)
52+
│ ├── [TOOL_NAME]/ <-------------------------- ADD DIR HERE
53+
│ │ ├── index.ts (defines and exports tools)
54+
│ │ ├── schemas.ts (defines input schema)
55+
│ │ └── handlers.ts (implements tool functionality)
56+
│ └── utils/ (shared tool utilities)
57+
```
58+
59+
### Best Practices for Tool Development
60+
61+
When developing new tools for Base MCP:
62+
63+
- Follow the existing code style and patterns
64+
- Ensure your tool has a clear, focused purpose
65+
- Provide comprehensive input validation
66+
- Include detailed error handling
67+
- Write thorough documentation
68+
- Add examples demonstrating how to use your tool
69+
- Include tests for your tool
70+
71+
For more detailed information on contributing to Base MCP, including adding new tools and protocols, see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
72+
2673
## Prerequisites
2774

2875
- Node.js (v16 or higher)
@@ -305,6 +352,19 @@ If you encounter issues:
305352

306353
Contributions are welcome! Please feel free to submit a Pull Request.
307354

355+
For detailed guidelines on contributing to Base MCP, including:
356+
- Reporting bugs
357+
- Suggesting enhancements
358+
- Development setup
359+
- Coding standards
360+
- **Adding new tools, protocols, and data sources** (see also the [Extending Base MCP](#extending-base-mcp-with-3p-protocols-tools-and-data-sources) section above)
361+
- Testing requirements
362+
- Documentation standards
363+
364+
Please refer to our comprehensive [CONTRIBUTING.md](CONTRIBUTING.md) guide.
365+
366+
Basic contribution steps:
367+
308368
1. Fork the repository
309369
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
310370
3. Commit your changes (`git commit -m 'Add some amazing feature'`)

‎public/SendUSDC.gif

5.84 MB
Loading

0 commit comments

Comments
 (0)