Skip to content

Commit 56e63bc

Browse files
committed
Clarify install instructions
1 parent 403edff commit 56e63bc

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,41 @@ The Model Context Protocol is an open protocol that enables seamless integration
5959

6060
### Installing the Plugin
6161

62-
Install via Composer:
62+
Install via Composer as a development dependency:
6363

6464
```bash
65-
composer require adaptic/synapse
65+
composer require --dev josbeir/cakephp-synapse
6666
```
6767

68-
Load the plugin in your `Application.php`:
68+
> [!NOTE]
69+
> This plugin is typically used as a development tool to allow AI assistants to interact with your application during development. It should not be installed in production environments.
70+
71+
Load the plugin using `config/plugins.php`:
72+
73+
```php
74+
// In config/plugins.php
75+
return [
76+
// ...
77+
'Synapse' => [
78+
'onlyCli' => true,
79+
'optional' => true,
80+
]
81+
// ...
82+
]
83+
```
84+
85+
Or load the plugin in your `Application.php`:
6986

7087
```php
7188
// In src/Application.php
7289
public function bootstrap(): void
7390
{
7491
parent::bootstrap();
7592

76-
$this->addPlugin('Synapse');
93+
$this->addPlugin('Synapse', [
94+
'onlyCli' => true,
95+
'optional' => true,
96+
]);
7797
}
7898
```
7999

@@ -282,6 +302,9 @@ Or run inside your DDEV instance
282302

283303
Discovery caching dramatically improves server startup performance by caching the discovered MCP elements (tools, resources, prompts). This can reduce startup time by up to 99%!
284304

305+
> [!NOTE]
306+
> While caching improves performance, remember that this plugin is intended for development use. The caching feature is most useful when running the MCP server frequently during development sessions.
307+
285308
### Configuration
286309

287310
Synapse uses CakePHP's built-in PSR-16 cache system. Configure caching in `config/synapse.php`:
@@ -329,7 +352,7 @@ bin/cake synapse server --clear-cache --verbose
329352

330353
- **Without cache**: ~100-500ms startup time (depending on codebase size)
331354
- **With cache**: ~1-5ms startup time (99% improvement!)
332-
- **Recommendation**: Always enable caching in production
355+
- **Recommendation**: Enable caching for faster startup times during development
333356

334357
## Testing
335358

@@ -365,7 +388,7 @@ Contributions are welcome! Please follow these guidelines:
365388

366389
```bash
367390
# Clone the repository
368-
git clone https://github.com/adaptic/synapse.git
391+
git clone https://github.com/josbeir/cakephp-synapse.git
369392
cd synapse
370393

371394
# Install dependencies

0 commit comments

Comments
 (0)