Skip to content

Commit 1f7df84

Browse files
committed
docs: add template maintenance section to README
Add documentation section explaining how to use the new template maintenance scripts for keeping MCP servers synchronized with template updates. Includes: - Instructions for merging template updates - Script installation for existing projects - References to detailed script documentation
1 parent 714a39e commit 1f7df84

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,27 @@ To add CLI functionality to your MCP server (like the Wayback Machine example):
321321

322322
This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
323323

324+
## Maintaining Your MCP Server
325+
326+
### Template Updates
327+
328+
This template includes scripts to help you merge updates from the template into your derived MCP server:
329+
330+
1. **Merge Updates**: Use `scripts/merge-template-updates.sh` to selectively merge template improvements while preserving your customizations.
331+
332+
2. **Analyze Differences**: Use `scripts/analyze-template-diff.sh` to understand what has changed between your server and the template.
333+
334+
See `scripts/README.md` for detailed documentation on using these maintenance scripts.
335+
336+
### Installing Scripts in Existing Projects
337+
338+
If you created your MCP server before these scripts were added:
339+
340+
```bash
341+
# From mcp-template directory
342+
./scripts/install-scripts.sh ../path-to-your-mcp-server
343+
```
344+
324345
## Contributing
325346

326347
Contributions are welcome! Please read our contributing guidelines and submit pull requests to our repository.

0 commit comments

Comments
 (0)