From 7d2cf34685d8b23dd18fe664e568db12dd77d31e Mon Sep 17 00:00:00 2001 From: David Dworken Date: Thu, 26 Jun 2025 17:19:46 -0700 Subject: [PATCH] Merge pull request #2 from ddworken/ddworken/add-examples-readme Add README for examples/ directory --- examples/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..c1265d2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,31 @@ +# DXT Examples + +This directory contains example Desktop Extensions that demonstrate the DXT format and manifest structure. These are **reference implementations** designed to illustrate how to build DXT extensions. + +## ⚠️ Not Production Ready + +**Important:** These examples are **NOT intended for production use**. They serve as: + +- Demonstrations of the DXT manifest format +- Templates for building your own extensions +- Simple MCP server implementations for testing + +But, the MCP servers themselves are not robust secure production ready servers and should not be relied upon for production use. + +## Examples Included + +| Example | Type | Demonstrates | +|---------|------|-------------| +| `hello-world-node` | Node.js | Basic MCP server with simple time tool | +| `chrome-applescript` | Node.js | Browser automation via AppleScript | +| `file-manager-python` | Python | File system operations and path handling | + +## Usage + +Each example includes its own `manifest.json` and can be packed with: + +```bash +dxt pack examples/hello-world-node +``` + +Use these as starting points for your own extensions, but ensure you implement proper security measures before deploying to users. \ No newline at end of file