You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-26Lines changed: 43 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,24 @@ A Strapi v5 plugin that integrates Model Context Protocol (MCP) functionality, e
21
21
22
22
> ⚠️ **SECURITY WARNING**: This plugin exposes internal Strapi functionality and should **NEVER** be enabled in production environments. It is designed for development and local use only. Always disable this plugin before deploying to production.
7.[🛠️ Available MCP Tools](#%EF%B8%8F-available-mcp-tools)
33
+
8.[💡 Usage Examples](#-usage-examples)
34
+
-[Content Type Exploration](#content-type-exploration)
35
+
-[System Information](#system-information)
36
+
-[Service Interaction](#service-interaction)
37
+
-[Common Workflows](#common-workflows)
38
+
9.[👨💻 Development](#-development)
39
+
10.[📝 License](#-license)
40
+
41
+
## 📖 Overview
25
42
26
43
This plugin provides MCP (Model Context Protocol) integration for Strapi, allowing AI assistants and other MCP clients to:
27
44
@@ -32,7 +49,7 @@ This plugin provides MCP (Model Context Protocol) integration for Strapi, allowi
32
49
33
50
The plugin exposes MCP tools through a streamable HTTP transport, making it easy to integrate with Claude Desktop, Cursor, and other MCP-compatible clients.
34
51
35
-
## Prerequisites
52
+
## 📋 Prerequisites
36
53
37
54
Before installing this plugin, ensure your environment meets the following requirements:
38
55
@@ -43,24 +60,20 @@ Before installing this plugin, ensure your environment meets the following requi
43
60
44
61
**Note**: After installation, you may need to restart your Strapi server for the plugin to be fully initialized.
After installation, the plugin will be automatically discovered by Strapi v5. No additional registration steps are required.
79
92
80
-
## Integration Guide
93
+
## 🔌 Integration Guide
81
94
82
95
### MCP Client Configuration
83
96
@@ -129,7 +142,7 @@ The plugin provides the following HTTP endpoints:
129
142
130
143
All endpoints support session-based communication with automatic session management.
131
144
132
-
## Configuration
145
+
## 🔧 Configuration
133
146
134
147
The plugin supports flexible session management through Strapi's configuration system. Add configuration to your `config/plugins.js` (or `config/plugins.ts`) file:
135
148
@@ -332,7 +345,7 @@ module.exports = {
332
345
};
333
346
```
334
347
335
-
## Usage
348
+
## 🚀 Usage
336
349
337
350
Once configured, the plugin automatically exposes MCP tools that clients can discover and use. The plugin provides tools for:
338
351
@@ -342,7 +355,7 @@ Once configured, the plugin automatically exposes MCP tools that clients can dis
342
355
343
356
MCP clients can discover available tools through the standard MCP protocol and invoke them as needed.
Once your MCP client is connected, you can interact with your Strapi instance using natural language. Here are comprehensive examples of how to use the plugin's capabilities:
The MCP integration makes it easy to explore and understand your Strapi instance through natural conversation, enabling better development planning and content management decisions.
520
533
521
-
## Development
534
+
## 👨💻 Development
522
535
523
536
For development and testing:
524
537
@@ -543,3 +556,7 @@ pnpm verify
543
556
```
544
557
545
558
The plugin follows Strapi v5 plugin architecture with separate admin and server components, built using TypeScript and the Model Context Protocol SDK.
559
+
560
+
## 📝 License
561
+
562
+
[MIT License](LICENSE.md) Copyright (c) [VirtusLab Sp. z o.o.](https://virtuslab.com/)&[Strapi Solutions](https://strapi.io/).
0 commit comments