Helpjuice MCP (Model Context Protocol) Server Overview
Access and manage your Helpjuice Knowledge Base programmatically
Table of Contents
Connection Information Available Tools Activities Backups Categories Groups Questions Searches Settings Users Webhooks Analytics Best PracticesThe Helpjuice MCP (Model Context Protocol) server allows developers to interact with their Helpjuice knowledge base through programmatic access. With around 53 tools organized across 10 categories, you can manage activities, backups, categories, users, groups, questions, webhooks, and analytics efficiently.
In this article, you’ll learn:
- What the Helpjuice MCP server is and what it offers
- How to connect to the MCP server
- The authentication and optional headers required
- Which tools are available and what each category includes
Connection Information
Protocol
The Helpjuice MCP server uses the HTTP Server protocol, also known as the HTTP Streamable protocol.
URL
All requests should be directed to: https://helpjuice.com/mcp
Authentication
You must pass your API key using the HTTP header: HTTP_X_API_KEY
To obtain your API key, see How to Get Your API Key.
Optional Headers
You can optionally include the following headers to customize your requests:
-
HTTP_X_USER_ID
- Scope results by the specified user ID -
HTTP_X_LANGUAGE_SHORTCODE
- Specify the language for responses (e.g., en_US, case sensitive)
Available Tools
Activities
There are 2 tools available:
- list_activities_tool.rb - List activities with filtering.
- show_activity_tool.rb - Show specific activity.
Backups
There are 2 tools available:
- list_backups_tool.rb - List all backups.
- show_backup_tool.rb - Show specific backup.
Categories
There are 5 tools available:
- list_categories_tool.rb - List categories.
- show_category_tool.rb - Show specific category.
- create_category_tool.rb - Create new category.
- update_category_tool.rb - Update category.
- destroy_category_tool.rb - Delete category.
Groups
There are 6 tools available:
- list_groups_tool.rb - List groups.
- show_group_tool.rb - Show specific group.
- create_group_tool.rb - Create new group.
- update_group_tool.rb - Update group.
- destroy_group_tool.rb - Delete group.
- list_group_users_tool.rb - List users in a group.
Questions
There are 7 tools available:
- list_questions_tool.rb - List questions/articles.
- show_question_tool.rb - Show specific question.
- create_question_tool.rb - Create new question.
- update_question_tool.rb - Update question.
- destroy_question_tool.rb - Delete question.
Searches
There is 1 tool available:
- search_tool.rb - Search knowledge base.
Settings
There are 2 tools available:
- get_account_settings_tool.rb - Get account settings.
- update_account_settings_tool.rb - Update account settings.
Users
There are 5 tools available:
- list_users_tool.rb - List users.
- show_user_tool.rb - Show specific user.
- create_user_tool.rb - Create new user.
- update_user_tool.rb - Update user.
- destroy_user_tool.rb - Remove user from account.
Webhooks
There are 7 tools available:
- list_webhooks_tool.rb - List webhooks.
- show_webhook_tool.rb - Show specific webhook.
- create_webhook_tool.rb - Create new webhook.
- update_webhook_tool.rb - Update webhook.
- destroy_webhook_tool.rb - Delete webhook.
- toggle_webhook_tool.rb - Toggle webhook active status.
- test_webhook_tool.rb - Test webhook.
Analytics
There are 16 tools available:
- list_category_analytics_tool.rb - Category analytics list.
- show_category_analytics_tool.rb - Specific category analytics.
- list_question_analytics_tool.rb - Question analytics list.
- show_question_analytics_tool.rb - Specific question analytics.
- list_question_search_terms_tool.rb - Search terms for question.
- list_question_users_tool.rb - Users who viewed question.
- list_search_analytics_tool.rb - Search analytics list.
- show_search_analytics_tool.rb - Specific search details.
- list_user_analytics_tool.rb - User analytics list.
- show_user_analytics_tool.rb - Specific user analytics.
- list_user_search_terms_tool.rb - User's search terms.
- list_user_questions_tool.rb - User's viewed questions.
- list_user_contributions_tool.rb - User's contributions.
- list_keyword_analytics_tool.rb - Top keywords.
- list_zero_result_keywords_tool.rb - Keywords with no results.
- list_group_analytics_tool.rb - Group analytics list.
- show_group_analytics_tool.rb - Specific group analytics.
Need more tools? Feel free to submit a Feature Request on our Community Forum.
Best Practices
- Always use your API key securely.
- Use optional headers to narrow down results and improve performance.
- Regularly check for updates to ensure compatibility with the latest MCP tools.
- Keep your API documentation accessible for quick reference.