@axolot-ai/mcp-server 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +79 -21
  3. package/package.json +9 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Axolot Development
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,43 +1,101 @@
1
- #  Axolot MCP Server
1
+ #  Axolot MCP Server — AI-Native Headless CMS Bridge
2
2
 
3
- Model Context Protocol (MCP) server for Axolot CMS. Give your AI assistant "hands" to manage your website content, structure, and infrastructure.
3
+ [![NPM Version](https://img.shields.io/npm/v/@axolot-ai/mcp-server?color=E67E22&style=flat-square)](https://www.npmjs.com/package/@axolot-ai/mcp-server)
4
+ [![Model Context Protocol](https://img.shields.io/badge/MCP-Supported-09B5C4?style=flat-square)](https://modelcontextprotocol.io)
5
+ [![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](https://github.com/axolot-ai/Axolot-MCP/blob/main/LICENSE)
4
6
 
5
- ## Features
7
+ **Axolot MCP Server** (`@axolot-ai/mcp-server`) implements Anthropic's **Model Context Protocol (MCP)** to expose your website's database schema, layouts, media library, design tokens, and module tools directly to local AI assistants (Cursor, Claude Desktop, Antigravity, VS Code, Zed).
6
8
 
7
- - **Master Content Tools**: List pages, read slots, and update content in real-time.
8
- - **Media Library Access**: Allow AI to browse and select assets for your site.
9
- - **Design Token Awareness**: Give AI context about your brand's colors, typography, and spacing.
10
- - **Zero-Effort Integration**: Works with Cursor, Claude Desktop, Zed, and any MCP-compatible client.
9
+ By running this server, you give your AI editor context-aware "hands" to fetch, build, and optimize pages, products, blog posts, and text slots within your exact design system constraints.
11
10
 
12
- ## Quickstart
11
+ ---
13
12
 
14
- ### Using npx (Recommended)
13
+ ## Key Capabilities
15
14
 
16
- Add this to your MCP settings (e.g., `claude_desktop_config.json`):
15
+ * **Surgical Content Orchestration**: The AI can query pages, read slots, and register new visual slots (`createSlot`) dynamically as it writes Astro components.
16
+ * **Media Library Access**: The AI browses available client assets, reading dimensions, file types, and vision-generated descriptions (`getMedia`) to select images automatically.
17
+ * **Brand Token Awareness**: Fetches active color schemes, font families, and spacing rules (`getDesignTokens`) to write style-compliant Tailwind or CSS code.
18
+ * **Module Management**: AI can query, create, or update articles in the **Blog Pro** module or products in the **Tienda Online (E-commerce)** module.
19
+
20
+ ---
21
+
22
+ ## 🔌 Setup & Configuration
23
+
24
+ Since the server is a Node.js CLI tool, the recommended way to run it is via **`npx`**, which requires zero local code installation or cloning.
25
+
26
+ ### A. Claude Desktop Integration
27
+
28
+ Add this snippet to your Claude Desktop configuration file (located at `%APPDATA%\Claude\claude_desktop_config.json` on Windows or `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
17
29
 
18
30
  ```json
19
31
  {
20
32
  "mcpServers": {
21
- "axolot": {
33
+ "axolot-cms": {
22
34
  "command": "npx",
23
- "args": ["-y", "@axolot-ai/mcp-server"]
35
+ "args": ["-y", "@axolot-ai/mcp-server"],
36
+ "env": {
37
+ "AXOLOT_API_URL": "https://api.axolotcms.com"
38
+ }
24
39
  }
25
40
  }
26
41
  }
27
42
  ```
28
43
 
29
- ### Authentication
44
+ ### B. Cursor Integration
45
+
46
+ 1. Open Cursor and go to **Settings -> Features -> MCP**.
47
+ 2. Click **"+ Add New MCP Server"**.
48
+ 3. Configure it as:
49
+ * **Name**: `axolot-cms`
50
+ * **Type**: `command`
51
+ * **Command**: `npx -y @axolot-ai/mcp-server`
52
+ 4. Add environment variables under settings if required, or log in interactively using the tools.
53
+
54
+ ---
55
+
56
+ ## 🛠️ Exposed AI Tools
57
+
58
+ Once connected, the AI will automatically invoke the following tools to fulfill your design prompts:
59
+
60
+ ### 🔑 Authentication & Context
61
+ * `cms_auth_login`: Triggers a secure authorization handshake URL in your browser.
62
+ * `cms_auth_status`: Verifies connection status, user role, and active site.
63
+ * `cms_switch_site`: Switches the active site context (site ID) when managing multiple client sites.
64
+
65
+ ### 🎨 Brand & Design
66
+ * `getDesignTokens`: Fetches active brand guidelines (colors, typography, spacing, border radius).
67
+ * `setDesignTokens`: Updates brand tokens in the database to establish brand styling.
68
+ * `getSiteSettings`: Fetches core business information (address, social links, email).
69
+
70
+ ### 📝 Layouts & Visual Slots
71
+ * `getPages`: Lists all pages and their corresponding registered editable content slots.
72
+ * `getSlots`: Reads details and values of slots on a specific page.
73
+ * `createSlot`: Registers a new editable slot key (e.g. `home.hero.title`) in the database.
74
+ * `createPage`: Generates a new page slug in the CMS structure.
75
+
76
+ ### 🛍️ Modules (Blog & Shop)
77
+ * `getBlogPosts` / `getBlogPost`: Queries post lists, drafts, and categories.
78
+ * `createBlogPost` / `updateBlogPost`: Creates and updates articles.
79
+ * `getProducts` / `getProduct` / `createProduct`: Manages product catalogs and attributes.
80
+ * `getMedia`: Lists media library files with WebP URLs and alt text descriptions.
81
+
82
+ ---
83
+
84
+ ## 🔒 Security & Sandboxing
85
+
86
+ The MCP server runs locally on your machine under your user context, connecting to the API via StdIO. It stores session authentication tokens securely in your user home directory at `~/.axolot/mcp-auth.json` (isolated by OS permissions). It never exposes public network ports or scans files outside your active development project directory.
30
87
 
31
- Once the server is running, use the following tools in your AI chat:
88
+ ---
32
89
 
33
- 1. `cms_auth_login`: To connect your account.
34
- 2. `cms_auth_status`: To verify the connection.
35
- 3. `cms_switch_site`: To select the target site.
90
+ ## 🔗 Useful Links
36
91
 
37
- ## Documentation
92
+ * **Official Website**: [axolotcms.com](https://axolotcms.com)
93
+ * **Client Dashboard**: [ai.axolotcms.com](https://ai.axolotcms.com)
94
+ * **Documentation & Guides**: [axolotcms.com/docs](https://axolotcms.com/docs)
95
+ * **Astro SDK Repository**: [github.com/AxolotDevelopment/Axolot-SDK](https://github.com/AxolotDevelopment/Axolot-SDK)
38
96
 
39
- Full documentation available at [axolot-cms.com/docs/mcp](https://axolot-cms.com/docs/mcp).
97
+ ---
40
98
 
41
- ## License
99
+ ## 📄 License
42
100
 
43
- MIT
101
+ Distributed under the MIT License. See `LICENSE` for more information.
package/package.json CHANGED
@@ -1,6 +1,14 @@
1
1
  {
2
2
  "name": "@axolot-ai/mcp-server",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "git+https://github.com/AxolotDevelopment/Axolot-MCP.git"
7
+ },
8
+ "bugs": {
9
+ "url": "https://github.com/AxolotDevelopment/Axolot-MCP/issues"
10
+ },
11
+ "homepage": "https://github.com/AxolotDevelopment/Axolot-MCP#readme",
4
12
  "type": "module",
5
13
  "description": "MCP server exposing AxolotCMS tools to AI designers",
6
14
  "bin": {