Ovice

You deploy an MCP server that bridges your organization’s workspace, groups, and user notifications to the oVice API. This server lets you list and access workspaces, manage groups and members, and send notifications at the organization, workspace, or group level, all through a unified, programmable interface.

How to use

You interact with the MCP server using standard MCP client tools in your environment. The server exposes a set of endpoints you can call to fetch workspaces, users, groups, and to send notifications. Use the client to list organization workspaces, retrieve workspace members, obtain space names from IDs, generate access URLs for workspaces, and push notifications to organizations, specific workspaces, or groups. Handle responses and errors in your client to reflect success states or detailed failure information.

How to install

Prerequisites: ensure you have a Node.js-enabled environment available. You will run the MCP server using a standard runtime command via a package runner.

{
  "mcpServers": {
    "ovice_mcp": {
      "command": "npx",
      "args": ["github:cti1650/ovice-mcp-server"],
      "env": {
        "OVICE_DOMAIN": "api.ovice.com",
        "OVICE_CLIENT_ID": "your-client-id",
        "OVICE_CLIENT_SECRET": "your-client-secret",
        "OVICE_ORGANIZATION_ID": "your-organization-id",
        "OVICE_SERVICE_NAME": "Your Service Name",
        "OVICE_SERVICE_LOGO_URL": "https://your-logo-url.com/logo.svg"
      }
    }
  }
}

Additional guidance for setup

To start the MCP server, run the runtime command via your shell or your MCP client configuration. This example uses a local npm/npx approach, so you can begin with the provided command configuration and environment variables. If you need to register the server in a client settings file, copy the block above and adapt the environment variable values to your own credentials and service details.

Configuration and environment

Required environment variables you must provide in your running environment to authorize with the oVice API are shown below. Replace the placeholder values with your actual credentials and identifiers.

OVICE_CLIENT_ID=your-client-id
OVICE_CLIENT_SECRET=your-client-secret
OVICE_ORGANIZATION_ID=your-organization-id
OVICE_DOMAIN=api.ovice.com
OVICE_SERVICE_NAME=Your Service Name
OVICE_SERVICE_LOGO_URL=https://your-logo-url.com/logo.svg

API usage and endpoints

This MCP server uses the oVice Public API v1. You will authenticate with the client ID and client secret in headers when making calls to get organization workspaces, workspace users, space names, access URLs, and to send notifications.

Error handling and troubleshooting notes

If required environment variables are missing or invalid, you will receive clear error messages indicating what is missing. When API calls fail, you will receive HTTP status codes and error details. If a requested resource cannot be found, you will see a specific error message indicating the missing resource.

Security considerations

Keep your client secret secure. Do not expose OVICE_CLIENT_SECRET in publicly accessible code or shared configurations. Use secret management practices to rotate credentials and limit access to the organization and service configuration.

Examples of common tasks

• List organization workspaces to understand the workspace landscape
• Fetch users for a given workspace by workspaceId
• Retrieve a space name from a spaceId
• Generate an access URL for a workspace using its workspaceId
• Send a notification to the entire organization
• Send a notification to a specific workspace with a chosen access level
• Send a notification to a specific group by groupId

Available tools

get_organization_workspaces

Retrieve the list of workspaces within the organization

get_workspace_users

Retrieve the user list for a specified workspace

get_space_name_by_id

Get the workspace name from a space ID

get_workspace_access_path

Generate an access URL for a workspace using its ID

get_organization_groups

Retrieve the list of groups within the organization

get_group_members

Retrieve the member list for a specified group

send_organization_notification

Send a notification to the entire organization

send_workspace_notification

Send a notification to a specific workspace with a given access level

send_group_notification

Send a notification to a specific group