- Home
- MCP servers
- EduBase
EduBase
- typescript
24
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
EduBase MCP Server enables third-party clients and LLMs to securely interact with your EduBase account, performing tasks on your behalf through flexible HTTP and local process transports.
How to use
You can connect an MCP client to EduBase in two primary ways: use the remote HTTP MCP server URL or run EduBase MCP locally as a stdio server. The HTTP option lets clients talk to EduBase over your secured remote endpoint. The local option lets you start a MCP process on your machine and communicate with it directly, using the same EduBase API bindings.
How to install
Prerequisites include having Node.js or Docker installed on your machine, depending on the installation method you choose.
- Build and run EduBase MCP server locally (Node.js)
# Prerequisites
# - Node.js installed
# 1. Clone the EduBase MCP server repository (or download the release)
# 2. Build the server
npm install
npm run build
# 3. Start the server (adjust the path to your built distribution as needed)
node /path/to/dist/index.js
- Run EduBase MCP server with Docker
# Prerequisites
# - Docker installed and running
# 1. Run the MCP server for EduBase using Docker
docker run -i --rm \
-e EDUBASE_API_URL=YOUR_EDUBASE_API_URL \
-e EDUBASE_API_APP=YOUR_INTEGRATION_APP_ID \
-e EDUBASE_API_KEY=YOUR_INTEGRATION_SECRET_KEY \
edubase/mcp
- Install via remote MCP server (Claude Desktop or other MCP clients)
# Use the remote EduBase MCP server endpoint
# Example configuration in your MCP client:
# HTTP URL: https://domain.edubase.net/mcp
- Install via Smithery (automatic Claude Desktop integration)
npx -y @smithery/cli install @EduBase/MCP --client claude
Configuration and environment
EduBase MCP server uses environment variables to connect to the EduBase API and to control transport modes. Ensure you provide the API URL, App ID, and Secret Key when required by your chosen transport. Below are the relevant variables and their purposes.
-
EDUBASE_API_URL: The base URL of the EduBase API (for example, https://subdomain.edubase.net/api). This value is required for secure communication.
-
EDUBASE_API_APP: The App ID of your integration app on EduBase. This is used for authentication with the API.
-
EDUBASE_API_KEY: The Secret key of your integration app on EduBase. This is used for authentication with the API.
-
EDUBASE_SSE_MODE: If true, start the MCP server in HTTP mode with Server-Sent Events transport.
-
EDUBASE_STREAMABLE_HTTP_MODE: If true, start the MCP server in HTTP mode with streamable HTTP transport.
-
EDUBASE_HTTP_PORT: The port the HTTP server listens on when using SSE or streamable HTTP transport. Default is 3000.
MCP connection options (explicit configurations)
You can connect to EduBase MCP in two ways: a remote HTTP endpoint or local stdio processes. If you configure a remote HTTP server, provide the endpoint URL in your client. If you run EduBase MCP locally, provide the command and environment to start the process.
Examples of MCP configurations
HTTP remote server configuration (preferred for remote clients)
{
"type": "http",
"name": "edubase_http",
"url": "https://domain.edubase.net/mcp",
"args": []
}
Local stdio server using Node.js (builds from dist/index.js)
{
"type": "stdio",
"name": "edubase_mcp",
"command": "node",
"args": ["/path/to/dist/index.js"],
"env": {
"EDUBASE_API_URL": "https://domain.edubase.net/api",
"EDUBASE_API_APP": "your_integration_app_id",
"EDUBASE_API_KEY": "your_integration_secret_key"
}
}
Local stdio server using Docker (EDUBASE_API_ values provided via environment)
{
"type": "stdio",
"name": "edubase_mcp_docker",
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"EDUBASE_API_URL",
"-e",
"EDUBASE_API_APP",
"-e",
"EDUBASE_API_KEY",
"edubase/mcp"
],
"env": {
"EDUBASE_API_URL": "https://domain.edubase.net/api",
"EDUBASE_API_APP": "your_integration_app_id",
"EDUBASE_API_KEY": "your_integration_secret_key"
}
}
Troubleshooting and notes
If you encounter authentication issues with remote servers, ensure you are using a Bearer token derived from your EduBase integration app credentials, formatted as base64-encoded app:secret and included in the Authorization header. For local setups, verify that your EDUBASE_API_URL, APP, and KEY values are correct and accessible from the host running the MCP process.