How do I use @nks-hub/nksweb-mcp?

1. Click on "Deploy Server". 2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state. 3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@@nks-hub/nksweb-mcp list all active pages" That's it! The server will respond to your query, and you can continue using it as needed. Here is a step-by-step guide with screenshots.

@nks-hub/nksweb-mcp

by nks-hub

Overview Schema Source Related Servers Discussions Admin

TypeScript

@nks-hub/nksweb-mcp

Build Status npm version Node.js TypeScript MCP SDK License: MIT

MCP server for NKS-Web CMS: manage pages, articles, news, files, users and analytics from Claude Code or any MCP-compatible client.

Requests an AI assistant can handle with it:

"List all active pages on the site"
"Create a new article about product updates"
"What are the top visited pages this month?"
"Show me browser breakdown from analytics"
"Switch to the acme tenant and list their news"

Features

🛠️ 49 tools - Pages, articles, categories, news, files, users, messages, redirects, settings, analytics and tenants
🧱 Content blocks - Create, update and delete the named HTML blocks of a page that the admin edits in Quill
🏢 Tenant switching - List tenants and send later requests to another tenant through the X-Tenant header
🔍 Page filtering - Filter pages by type, status and language, or search name, URL slug and HTML content
📊 Analytics - Overview, top pages, referrers and a breakdown by 14 dimensions such as country, browser, device and UTM parameters
🏷️ Tool annotations - Each tool carries the MCP readOnlyHint, destructiveHint and idempotentHint hints
✂️ Response truncation - Lists over 25,000 characters are cut to half the items with a note to paginate; other responses are cut at 25,000 characters
💬 Error messages - HTTP 400, 401, 403, 404, 409, 429, 502 and 503 each map to a message that names the cause, such as a missing API key scope

Related MCP server: @uselink/mcp

Requirements

Node.js: 18+
NKS-Web CMS: Instance with API enabled and API key created

Installation

Run it with npx without installing:

npx -y @nks-hub/nksweb-mcp

Or install globally:

npm install -g @nks-hub/nksweb-mcp

From source

git clone https://github.com/nks-hub/nksweb-mcp.git
cd nksweb-mcp
npm install && npm run build

Configuration

Add to your ~/.claude/.mcp.json or project-level MCP config:

{
  "mcpServers": {
    "nksweb": {
      "command": "npx",
      "args": ["-y", "@nks-hub/nksweb-mcp"],
      "env": {
        "NKSWEB_URL": "https://your-site.com",
        "NKSWEB_API_KEY": "nks_your_api_key"
      }
    }
  }
}

When built from source, use "command": "node" with "args": ["/path/to/nksweb-mcp/build/index.js"] instead.

Or via Claude Code CLI:

claude mcp add nksweb -e NKSWEB_URL=https://your-site.com -e NKSWEB_API_KEY=nks_key -- npx -y @nks-hub/nksweb-mcp

Environment variables

Variable	Required	Description
`NKSWEB_URL`	Yes	Base URL of the NKS-Web instance (e.g. `https://your-site.com`)
`NKSWEB_API_KEY`	Yes	API key with appropriate scopes (prefix `nks_`)

Usage

Once configured, the MCP client sees the tools listed below and calls them when you ask about CMS content.

Tools (49)

Pages (8 tools)

Tool	Description
`nksweb_list_pages`	List pages with optional filters: `type`, `status`, `search`, `lang`
`nksweb_get_page`	Get full page detail by ID including HTML content and extraData
`nksweb_create_page`	Create a new page with content, type, SEO, and navigation settings
`nksweb_update_page`	Update an existing page (partial update: send only changed fields)
`nksweb_delete_page`	Delete a page (soft-delete)
`nksweb_list_content_blocks`	List all named content blocks for a page
`nksweb_upsert_content_block`	Create or update a single content block by key
`nksweb_delete_content_block`	Delete a content block from a page

Articles (5 tools)

Tool	Description
`nksweb_list_articles`	List all articles
`nksweb_get_article`	Get article detail by ID
`nksweb_create_article`	Create article with content, categories, and SEO
`nksweb_update_article`	Update an existing article
`nksweb_delete_article`	Delete an article

Categories (5 tools)

Tool	Description
`nksweb_list_categories`	List all article categories
`nksweb_get_category`	Get category detail by ID
`nksweb_create_category`	Create a category (supports nested tree)
`nksweb_update_category`	Update a category
`nksweb_delete_category`	Delete a category

News (5 tools)

Tool	Description
`nksweb_list_news`	List all news items
`nksweb_get_news_item`	Get news item detail by ID
`nksweb_create_news`	Create a news item
`nksweb_update_news`	Update a news item
`nksweb_delete_news`	Delete a news item

Files (3 tools)

Tool	Description
`nksweb_list_files`	List all uploaded files
`nksweb_get_file`	Get file metadata by ID
`nksweb_delete_file`	Delete a file

Users (5 tools)

Tool	Description
`nksweb_list_users`	List all admin users
`nksweb_get_user`	Get user detail by ID
`nksweb_create_user`	Create a new admin user
`nksweb_update_user`	Update user profile or role
`nksweb_delete_user`	Delete a user

Messages (4 tools)

Tool	Description
`nksweb_list_messages`	List all contact form messages
`nksweb_get_message`	Get message detail by ID
`nksweb_mark_message_read`	Mark a message as read/unread
`nksweb_delete_message`	Delete a message

Redirects (5 tools)

Tool	Description
`nksweb_list_redirects`	List all URL redirects
`nksweb_get_redirect`	Get redirect detail by ID
`nksweb_create_redirect`	Create a redirect rule (301/302/307)
`nksweb_update_redirect`	Update a redirect
`nksweb_delete_redirect`	Delete a redirect

Settings (3 tools)

Tool	Description
`nksweb_list_settings`	List all tenant settings
`nksweb_get_setting`	Get a specific setting by key
`nksweb_update_settings`	Update one or more settings

Analytics (4 tools)

Tool	Description
`nksweb_analytics_overview`	Traffic overview: sessions, pageviews, users, bounce rate, avg duration
`nksweb_analytics_pages`	Top visited pages with visit count, pageviews, bounce rate
`nksweb_analytics_referrers`	Top traffic sources with visit count and percentage
`nksweb_analytics_metric`	Breakdown by dimension: `country`, `browser`, `os`, `device_type`, `city`, `region`, `language`, `utm_source`, `utm_medium`, `utm_campaign`, `utm_content`, `utm_term`, `pathname`, `referrer`

Tenants (2 tools)

Tool	Description
`nksweb_list_tenants`	List available tenants (multi-tenant key: all tenants, single-tenant key: current tenant)
`nksweb_set_tenant`	Switch the active tenant; all subsequent operations target it

API key scopes

Each tool needs the matching scope on the API key:

Scope	Tools
`pages:read`	list, get pages and content blocks
`pages:write`	create, update, delete pages and content blocks
`articles:read` / `articles:write`	article management
`categories:read` / `categories:write`	category management
`news:read` / `news:write`	news management
`files:read` / `files:write`	file management
`users:read` / `users:write`	user management
`messages:read` / `messages:write`	message management
`redirects:read` / `redirects:write`	redirect management
`settings:read` / `settings:write`	settings management
`analytics:read`	analytics access
`tenants:read`	tenant listing

Page filtering

nksweb_list_pages accepts these filters:

Parameter	Type	Description
`type`	string	Filter by page type: `default`, `homepage`, `contact`, `gallery`, `pricing`, `team`, `faq`, `news`, `articles`, `video_gallery`, `product`, `features`, `templates`, `demo`, `nks-pricing`
`status`	number	`0` = disabled/draft, `1` = active/published
`search`	string	Full-text search across page name, URL slug, and HTML content
`lang`	string	ISO 639-1 language code (e.g. `cs`, `en`)

Analytics parameters

All analytics tools accept these optional parameters:

Parameter	Type	Description
`startDate`	string	Start date `YYYY-MM-DD` (default: 30 days ago)
`endDate`	string	End date `YYYY-MM-DD` (default: today)
`limit`	number	Max results 1–100 (default: 10)

Available metrics

Dimensions for nksweb_analytics_metric:

Metric	Description
`pathname`	Page paths (same as top pages)
`referrer`	Traffic sources
`country`	Visitor countries
`region`	Visitor regions/states
`city`	Visitor cities
`browser`	Browser names (Chrome, Firefox, Safari, ...)
`os`	Operating systems (Windows, macOS, iOS, Android, ...)
`device_type`	Device categories (desktop, mobile, tablet)
`language`	Browser language settings
`utm_source`	UTM source parameter
`utm_medium`	UTM medium parameter
`utm_campaign`	UTM campaign parameter
`utm_content`	UTM content parameter
`utm_term`	UTM term parameter

Examples

Content management

User: "List all active pages"
→ nksweb_list_pages { status: 1 }

User: "Find pages containing 'pricing'"
→ nksweb_list_pages { search: "pricing" }

User: "Show me the homepage"
→ nksweb_list_pages { type: "homepage" }

User: "Create a new FAQ page"
→ nksweb_create_page { name: "FAQ", url: "faq", type: "faq", status: 1,
    content: "<h1>Frequently Asked Questions</h1>" }

User: "Update the hero heading on homepage"
→ nksweb_upsert_content_block { pageId: 14, key: "hero_heading",
    content: "Digital Solutions That Work", label: "Hero Heading" }

Analytics

User: "How's the site traffic this month?"
→ nksweb_analytics_overview { startDate: "2026-03-01" }

User: "What browsers do our visitors use?"
→ nksweb_analytics_metric { metric: "browser", limit: 10 }

User: "Show country breakdown for last week"
→ nksweb_analytics_metric { metric: "country",
    startDate: "2026-03-02", endDate: "2026-03-09" }

User: "Top 5 most visited pages"
→ nksweb_analytics_pages { limit: 5 }

User: "Where does our traffic come from?"
→ nksweb_analytics_referrers {}

Multi-tenant

User: "What tenants are available?"
→ nksweb_list_tenants {}

User: "Switch to the acme tenant"
→ nksweb_set_tenant { slug: "acme" }

User: "Now list their pages"
→ nksweb_list_pages {}  (automatically targets acme)

User: "Go back to default"
→ nksweb_set_tenant { slug: "" }

Articles and news

User: "Create an article about our new feature"
→ nksweb_create_article { title: "Introducing Smart Search",
    url: "introducing-smart-search", status: 1,
    content: "<p>We're excited to announce...</p>" }

User: "List all news items"
→ nksweb_list_news {}

User: "Delete news item #5"
→ nksweb_delete_news { id: 5 }

Settings and redirects

User: "What settings does this tenant have?"
→ nksweb_list_settings {}

User: "Add a redirect from /old-page to /new-page"
→ nksweb_create_redirect { source: "/old-page", target: "/new-page",
    statusCode: 301, isActive: true }

User: "Show all contact form messages"
→ nksweb_list_messages {}

Project structure

nksweb-mcp/
├── src/
│   ├── index.ts          # Entry point, MCP server setup
│   ├── client.ts         # HTTP client with tenant switching (X-Tenant header)
│   ├── constants.ts      # Timeouts and limits
│   └── tools/
│       ├── pages.ts      # Pages + content blocks (8 tools)
│       ├── articles.ts   # Articles CRUD (5 tools)
│       ├── categories.ts # Categories CRUD (5 tools)
│       ├── news.ts       # News CRUD (5 tools)
│       ├── files.ts      # Files management (3 tools)
│       ├── users.ts      # Users CRUD (5 tools)
│       ├── messages.ts   # Messages management (4 tools)
│       ├── redirects.ts  # Redirects CRUD (5 tools)
│       ├── settings.ts   # Settings management (3 tools)
│       ├── analytics.ts  # Analytics queries (4 tools)
│       └── tenants.ts    # Multi-tenant switching (2 tools)
├── tests/
│   └── integration.test.ts
├── build/                # Compiled JS output
├── package.json
├── tsconfig.json
└── LICENSE

Development

git clone https://github.com/nks-hub/nksweb-mcp.git
cd nksweb-mcp

# Install dependencies
npm install

# Build
npm run build

# Watch mode
npm run dev

# Run integration tests
npm test

# Type checking
npx tsc --noEmit

Contributing

Contributions are welcome! For major changes, please open an issue first.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'feat: description')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Support

📧 Email: dev@nks-hub.cz
🐛 Bug reports: GitHub Issues
📖 MCP Protocol: modelcontextprotocol.io

License

MIT License — see LICENSE for details.

This server cannot be deployed

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Maintenance

ActivityNo data

ResponsivenessNo issues

Resources

Need Help?

Related Servers

Related MCP Connectors

Create Web Page A
com.create-web-page
Create, edit, preview, publish, and manage web pages from MCP-capable AI clients.
Content Management Systems Developer Tools
272
Artificial Wit AIOAuth
com.artificialwit
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
ERP Systems CRM Knowledge & Memory
2
mcp-serverOAuth
com.niftypm
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
Project Management Communication File Systems
2
UnifAPIOAuth
com.unifapi
Hosted MCP server for live public-data APIs and Skills for AI agents.
Open Data Search AI & Machine Learning
2

Related MCP Servers

vulcan-file-ops
File Systems Developer Tools Command Line
n0zer0d4y
A
license
A
quality
A
maintenance
MCP server that gives Claude Desktop and other desktop MCP clients filesystem powers—read, write, edit, and manage files like AI coding assistants.
Updated 5 days ago (2026-10-18 08:13 UTC)
17
37 npm
9
MIT
@uselink/mcp
Content Management Systems Documentation Access
c0x12c
A
license
B
quality
C
maintenance
MCP server to publish HTML/Markdown docs, upload assets, and reply to stakeholder comments on uselink.app directly from AI tools like Claude and Cursor.
Updated 5 months ago (2026-06-05 04:53 UTC)
34
3 npm
MIT
srgplus-mcpofficial
Content Management Systems Workplace & Productivity
srgplus
A
license
B
quality
B
maintenance
MCP server for SRG+ — lets Claude (and any MCP-aware agent) manage hubs, channels, content, assets, users, and workspaces through the SRG+ API.
Updated 20 days ago (2026-10-03 19:48 UTC)
103
30 PyPI
MIT
digihub-mcp
Content Management Systems Marketing
M0TT3P
A
license
B
quality
D
maintenance
MCP server for the digihub.li content API, enabling Claude to read and write Stories, Solutions, and Sessions, and upload images for media.
Updated 4 months ago (2026-06-18 15:42 UTC)
17
8 npm
MIT

@nks-hub/nksweb-mcp

Features

Requirements

Installation

From source

Configuration

Environment variables

Usage

Tools (49)

Pages (8 tools)

Articles (5 tools)

Categories (5 tools)

News (5 tools)

Files (3 tools)

Users (5 tools)

Messages (4 tools)

Redirects (5 tools)

Settings (3 tools)

Analytics (4 tools)

Tenants (2 tools)

API key scopes

Page filtering

Analytics parameters

Available metrics

Examples

Content management

Analytics

Multi-tenant

Articles and news

Settings and redirects

Project structure

Links

Development

Contributing

Support

License

Maintenance

Resources

Related MCP Connectors

Related MCP Servers

vulcan-file-ops

@uselink/mcp

srgplus-mcpofficial

digihub-mcp