Merge pull request #2 from ddworken/ddworken/add-examples-readme
Add README for examples/ directory
This commit is contained in:
parent
c38b236d83
commit
7d2cf34685
1 changed files with 31 additions and 0 deletions
31
examples/README.md
Normal file
31
examples/README.md
Normal file
|
|
@ -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.
|
||||
Loading…
Reference in a new issue