headlesshost-mcp-server 1.0.0

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.
package/README.md ADDED
@@ -0,0 +1,193 @@
1
+ # Headlesshost MCP Server
2
+
3
+ A comprehensive Model Context Protocol (MCP) server that provides complete communication with the Headlesshost platform API endpoints. This server enables AI assistants to interact with all aspects of the Headlesshost platform including user management, content site operations, staging site management, content generation, analytics, and system administration.
4
+
5
+ ## Demo
6
+
7
+ https://www.youtube.com/watch?v=xGGwcrI7gSo&feature=youtu.be
8
+
9
+ ## Features
10
+
11
+ ### 🔧 General System Tools (4 tools)
12
+
13
+ - **Ping**: Test authentication and connection to the Headlesshost API
14
+ - **Health**: Check API health status and connectivity
15
+ - **Reference Data**: Access system reference data and lookups
16
+
17
+ ### 📁 File Management (2 tools)
18
+
19
+ - **Upload Profile Image**: Upload user profile images
20
+ - **Upload Staging Site File**: Upload files to staging sites
21
+
22
+ ### 👥 Membership Management (8 tools)
23
+
24
+ - **User Registration**: Register new users with account creation
25
+ - **User Management**: Full CRUD operations for users with claims/roles support
26
+ - **Account Management**: View and update account information
27
+
28
+ ### 🏢 Content Site Management (6 tools)
29
+
30
+ - **Content Site Creation**: Create new content site entities
31
+ - **Content Site Listing**: View all content sites with optional filters
32
+ - **Content Site Details**: Get comprehensive content site information
33
+ - **Content Site Updates**: Modify content site settings and configuration
34
+ - **Content Site Deletion**: Remove content sites from the platform
35
+
36
+ ### 🌐 Staging Site Management (67 tools)
37
+
38
+ Comprehensive staging site functionality including:
39
+
40
+ #### Core Operations (4 tools)
41
+
42
+ - **Site Operations**: Update, delete, publish staging sites
43
+ - **Site Information**: Get staging site details and metadata
44
+ - **Site Management**: Clone, promote, and revert staging sites
45
+ - **Published Sites**: Access published site versions
46
+
47
+ #### Page Management (4 tools)
48
+
49
+ - **Page CRUD**: Create, read, update, delete staging site pages
50
+ - **Page Content**: Handle page content and structure
51
+ - **Page Analytics**: Track page-level performance
52
+ - **Page Logs**: Monitor page activity and changes
53
+
54
+ #### Section Management (6 tools)
55
+
56
+ - **Section CRUD**: Create, read, update, delete page sections
57
+ - **Section Content**: Manage section-specific content
58
+ - **Section Logs**: Track section-level modifications
59
+
60
+ #### User Management (5 tools)
61
+
62
+ - **User Access Control**: Grant and manage user access to staging sites
63
+ - **Role Management**: Assign and update user roles per site
64
+ - **Permissions**: Configure granular user permissions
65
+ - **User Listing**: View all site users and their roles
66
+
67
+ #### Business Operations (7 tools)
68
+
69
+ - **Business Logs**: Access business activity and audit trails
70
+ - **Business Analytics**: Business-level performance metrics
71
+ - **User Management**: Business user access and permissions
72
+ - **Role Management**: Business role definitions and assignments
73
+
74
+ #### System Resources (8 tools)
75
+
76
+ - **Hit Tracking**: Raw analytics data and visitor metrics
77
+ - **System Health**: Monitor platform connectivity and status
78
+
79
+ ## 📈 Total Coverage
80
+
81
+ **87 Tools** providing complete API coverage across all Headlesshost platform functionality!
82
+
83
+ ## Installation
84
+
85
+ 1. Clone this repository
86
+ 2. Install dependencies:
87
+
88
+ ```bash
89
+ npm install
90
+ ```
91
+
92
+ 3. Build the server:
93
+ ```bash
94
+ npm run build
95
+ ```
96
+
97
+ ## Configuration
98
+
99
+ Set up your environment variables:
100
+
101
+ ```bash
102
+ export HEADLESSHOST_API_KEY="your-auth-token"
103
+ ```
104
+
105
+ Or create a `.env` file:
106
+
107
+ ```env
108
+ HEADLESSHOST_API_KEY=your-auth-token
109
+ ```
110
+
111
+ ## Usage
112
+
113
+ ### With Claude Desktop
114
+
115
+ Add this configuration to your Claude Desktop config file:
116
+
117
+ On a Mac (edit or create this file).
118
+
119
+ ```bash
120
+ /Users/warren/Library/Application Support/Claude/claude_desktop_config.json
121
+ ```
122
+
123
+ ```json
124
+ {
125
+ "mcpServers": {
126
+ "Headlesshost-cms": {
127
+ "command": "node",
128
+ "args": ["/path/to/Headlesshost-mcp/build/index.js"],
129
+ "env": {
130
+ "HEADLESSHOST_API_KEY": "your-auth-token"
131
+ }
132
+ }
133
+ }
134
+ }
135
+ ```
136
+
137
+ ### With Other MCP Clients
138
+
139
+ This server is compatible with any MCP client including:
140
+
141
+ - VS Code with MCP extensions
142
+ - Zed Editor
143
+ - Continue.dev
144
+ - Custom MCP implementations
145
+
146
+ Configure your client to use:
147
+
148
+ - **Command**: `node`
149
+ - **Args**: `["/path/to/Headlesshost.mcp/build/index.js"]`
150
+ - **Environment**: Set `HEADLESSHOST_API_KEY`
151
+
152
+ ### Development
153
+
154
+ Build the server:
155
+
156
+ ```bash
157
+ npm run build
158
+ ```
159
+
160
+ Run the server directly:
161
+
162
+ ```bash
163
+ npm start
164
+ ```
165
+
166
+ Run the MCP inspector for debugging:
167
+
168
+ ```bash
169
+ npm run inspector
170
+ ```
171
+
172
+ ## Resources
173
+
174
+ The server provides 2 resources for configuration and monitoring:
175
+
176
+ - **API Configuration**: Current Headlesshost API settings and endpoints
177
+ - **API Health Status**: Real-time connectivity and health information
178
+
179
+ ## Error Handling
180
+
181
+ The server includes comprehensive error handling with:
182
+
183
+ - API authentication validation
184
+ - Network connectivity checks
185
+ - Detailed error messages and troubleshooting information
186
+ - Graceful fallbacks for API timeouts
187
+
188
+ ## Security
189
+
190
+ - API key authentication required for all operations
191
+ - Secure environment variable handling
192
+ - Request/response logging for audit trails
193
+ - Input validation and sanitization
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}