Skip to content

Commit 18b3a9b

Browse files
authored
Merge pull request #10 from VirtusLab-Open-Source/docs/readme-alignment
docs: Readme.md alignment
2 parents ed3825b + 6c4fe38 commit 18b3a9b

File tree

2 files changed

+44
-27
lines changed

2 files changed

+44
-27
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Max
3+
Copyright (c) 2025 VirtusLab Sp. z o.o.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,24 @@ A Strapi v5 plugin that integrates Model Context Protocol (MCP) functionality, e
2121

2222
> ⚠️ **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.
2323
24-
## Overview
24+
1. [📖 Overview](#-overview)
25+
2. [📋 Prerequisites](#-prerequisites)
26+
3. [⏳ Installation](#-installation)
27+
4. [🔌 Integration Guide](#-integration-guide)
28+
5. [🔧 Configuration](#-configuration)
29+
- [Memory Session Management](#memory-session-management)
30+
- [Redis Session Management](#redis-session-management)
31+
6. [🚀 Usage](#-usage)
32+
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
2542

2643
This plugin provides MCP (Model Context Protocol) integration for Strapi, allowing AI assistants and other MCP clients to:
2744

@@ -32,7 +49,7 @@ This plugin provides MCP (Model Context Protocol) integration for Strapi, allowi
3249

3350
The plugin exposes MCP tools through a streamable HTTP transport, making it easy to integrate with Claude Desktop, Cursor, and other MCP-compatible clients.
3451

35-
## Prerequisites
52+
## 📋 Prerequisites
3653

3754
Before installing this plugin, ensure your environment meets the following requirements:
3855

@@ -43,24 +60,20 @@ Before installing this plugin, ensure your environment meets the following requi
4360

4461
**Note**: After installation, you may need to restart your Strapi server for the plugin to be fully initialized.
4562

46-
## Table of Contents
47-
48-
- [Prerequisites](#prerequisites)
49-
- [Installation](#installation)
50-
- [Integration Guide](#integration-guide)
51-
- [Configuration](#configuration)
52-
- [Memory Session Management](#memory-session-management)
53-
- [Redis Session Management](#redis-session-management)
54-
- [Usage](#usage)
55-
- [Available MCP Tools](#available-mcp-tools)
56-
- [Usage Examples](#usage-examples)
57-
- [Content Type Exploration](#content-type-exploration)
58-
- [System Information](#system-information)
59-
- [Service Interaction](#service-interaction)
60-
- [Common Workflows](#common-workflows)
61-
- [Development](#development)
62-
63-
## Installation
63+
### Table of Contents
64+
65+
1. [📖 Overview](#-overview)
66+
2. [📋 Prerequisites](#-prerequisites)
67+
3. [⏳ Installation](#-installation)
68+
4. [🔌 Integration Guide](#-integration-guide)
69+
5. [🔧 Configuration](#-configuration)
70+
6. [🚀 Usage](#-usage)
71+
7. [🛠️ Available MCP Tools](#%EF%B8%8F-available-mcp-tools)
72+
8. [💡 Usage Examples](#-usage-examples)
73+
9. [👨‍💻 Development](#-development)
74+
10. [📝 License](#-license)
75+
76+
## ⏳ Installation
6477

6578
Install the plugin using your preferred package manager:
6679

@@ -77,7 +90,7 @@ pnpm add @sensinum/strapi-plugin-mcp
7790

7891
After installation, the plugin will be automatically discovered by Strapi v5. No additional registration steps are required.
7992

80-
## Integration Guide
93+
## 🔌 Integration Guide
8194

8295
### MCP Client Configuration
8396

@@ -129,7 +142,7 @@ The plugin provides the following HTTP endpoints:
129142

130143
All endpoints support session-based communication with automatic session management.
131144

132-
## Configuration
145+
## 🔧 Configuration
133146

134147
The plugin supports flexible session management through Strapi's configuration system. Add configuration to your `config/plugins.js` (or `config/plugins.ts`) file:
135148

@@ -332,7 +345,7 @@ module.exports = {
332345
};
333346
```
334347

335-
## Usage
348+
## 🚀 Usage
336349

337350
Once configured, the plugin automatically exposes MCP tools that clients can discover and use. The plugin provides tools for:
338351

@@ -342,7 +355,7 @@ Once configured, the plugin automatically exposes MCP tools that clients can dis
342355

343356
MCP clients can discover available tools through the standard MCP protocol and invoke them as needed.
344357

345-
## Available MCP Tools
358+
## 🛠️ Available MCP Tools
346359

347360
The plugin exposes several categories of tools:
348361

@@ -388,7 +401,7 @@ mcpCustomService.registerTool({
388401
});
389402
```
390403

391-
## Usage Examples
404+
## 💡 Usage Examples
392405

393406
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:
394407

@@ -518,7 +531,7 @@ Perform complex schema analysis:
518531

519532
The MCP integration makes it easy to explore and understand your Strapi instance through natural conversation, enabling better development planning and content management decisions.
520533

521-
## Development
534+
## 👨‍💻 Development
522535

523536
For development and testing:
524537

@@ -543,3 +556,7 @@ pnpm verify
543556
```
544557

545558
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

Comments
 (0)