# SJS.Neos.MCP

> [!WARNING]
> This package may work on Neos 8 but this is NOT TESTED!
> It is also under development so things can change

Core MCP (Model Context Protocol) server implementation for Neos CMS 9.x.

> [!IMPORTANT]
> 🚧 [This is the Roadmap up to Version 1.0](./Roadmap.md)

---

## Quick Start

### Neos 9

To get started fast install this FeatureSet:

**[SJS.Neos.MCP.FeatureSet.Agent](https://github.com/sjsone/SJS.Neos.MCP.FeatureSet.Agent)** — Agent knowledge, analysis, and scenario tools

```bash
composer require sjs/neos-mcp sjs/neos-mcp-feature-set-agent
```

Then run the migration

```bash
./flow doctrine:migrate
```

## Configuration

Server instances are defined in `Configuration/Settings.Server.yaml`:

```yaml
SJS:
  Neos:
    MCP:
      server:
        mcp: # <-- This is the default for now
          featureSets:
            myFeatureSet: \Vendor\Site\MCP\FeatureSet\MyFeatureSet
```

Multiple named server instances can coexist alongside `mcp`.

> [!WARNING]
> Currently only `mcp` is used as it is hardcoded for now.

---

## Implementing new Features

### Adding a new FeatureSet

1. Create a class extending `AbstractFeatureSet` with `#[Flow\Scope("singleton")]`.
2. Implement `initialize()` to register tools via `$this->addTool(...)`.
3. Optionally override `resourcesList()`, `resourcesRead()`, `resourcesTemplatesList()`, `completionComplete()`.
4. Register the class in `Configuration/Settings.Server.yaml` under `server.mcp.featureSets`.

#### Tool name prefixes

`AbstractFeatureSet` automatically derives a prefix from the class name (e.g., `WorkspaceFeatureSet` → prefix `workspace`). Tool names are exposed as `{prefix}_{tool_name}`.

---

## Development

### MCP Inspector

```sh
yarn run mcp-inspector-cli
```

Launches the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) UI for interactive testing.

### References

- [Model Context Protocol](https://modelcontextprotocol.io/)
- [MCP Inspector](https://github.com/modelcontextprotocol/inspector)

### Related

- **[SJS.Flow.MCP](https://github.com/sjsone/SJS.Flow.MCP)** — Flow framework MCP abstractions (server, tools, FeatureSets)
- **[SJS.Neos.MCP.OAuth](https://github.com/sjsone/SJS.Neos.MCP.OAuth)** — OAuth 2.0 authentication for the MCP server