oneserver Logo
oneserver
Usage Guide

Using OneServer

This section details the core features of OneServer for managing your MCP ecosystem.

Managing Servers

Servers are the providers of MCP capabilities (Tools, Prompts, Resources). OneServer helps you add, configure, and understand these servers.

Viewing Servers

  • Added servers are listed in the left sidebar under the STDIO or SSE categories.
  • Clicking a server name opens its details in the Right Detail Panel.

Adding/Editing Servers

  • Adding: Use the ”+” button next to STIDO/SSE or the templates in the “Discover Servers” dashboard panel (See Getting Started).
  • Editing:
    1. Select the server in the sidebar.
    2. In the Right Detail Panel, click the Edit icon ( ).
    3. Modify the Name, Description, Command/URL, or Environment Variables as needed.
    4. Important: If you change the Command or URL, you must run “Discover Resources” again before saving (see Discovery section below).
    5. Click “Save” at the bottom of the form.

Server Details View

When viewing a server’s details, you’ll see:

  • Basic Info: ID, Name, Transport (Stdio/SSE), Created/Updated timestamps, Description.
  • Configuration: The Command (Stdio) or URL (SSE) used. Environment variables are also shown if set for Stdio servers.
  • Discovery Button: Allows re-running resource discovery.
  • Discovered Resources Panel: An expandable section showing the Tools, Prompts, Resources, Resource Templates, and Capabilities last discovered for this server.

Discovering Server Capabilities

A core feature is discovering what a server offers:

  1. Trigger Discovery: When adding/editing a server, click the “Discover Resources” button ( icon). This is automatic when adding from a template.
  2. Process: OneServer connects to the server using the provided configuration (Command/URL/Env). For SSE, it handles OAuth automatically if required. It then queries the server for its capabilities.
  3. View Results: The Discovered Resources panel below the button updates. Expand categories (Tools, Prompts, etc.) to see details.
  4. Requirement for Saving (Manual Add): Discovery must succeed and find at least one capability before you can save a new, manually added server.
  5. Re-Discovery: If you change the Command/URL on an existing server, you must re-discover before saving to ensure the stored capabilities are accurate. A warning prompt will appear if you change these fields after a prior discovery.

Removing Servers

  1. Select the server in the sidebar.
  2. In the Right Detail Panel, click the Delete icon ( ).
  3. Confirm the deletion in the dialog box that appears.
  4. The server and its associations with clients will be removed. A server.deleted event will appear in System Events.

Managing Clients

Clients are the applications that use MCP servers via OneServer.

Viewing Clients

  • Detected and configured clients appear in the left sidebar under “Clients”.
  • Each client shows a status indicator of Detected, Configured, or Error.
  • Clicking a client name opens its details in the Right Detail Panel.

Client Details View

When viewing a client’s details, you’ll see:

  • Basic Info: ID, Name, Status, Created/Updated timestamps.
  • Config Path: The filesystem path to the configuration file OneServer is managing for this client.
  • Associated Servers: A list of all servers known to OneServer, each with a toggle switch indicating if this client can access it.
  • Connector Action Button: Either “Install OneServer Connector” or “Uninstall OneServer Connector”.

Installing/Uninstalling the Connector

  • Install: If a client’s status is “Detected” or “Error”, click “Install OneServer Connector” ( ) in the details panel footer. This modifies the client’s config and changes the status to “Configured”.
  • Uninstall: If a client’s status is “Configured”, click “Uninstall OneServer Connector” ( ) in the details panel footer. Confirm the action. This removes OneServer settings from the client’s config, and the status reverts to “Detected”.

Associating Servers with Clients

Control which servers a client can use:

  • Method 1: Instant Toggle (View Mode)
    • While viewing Client Details (not Edit mode).
    • Find the server in the “Associated Servers” list.
    • Click the toggle switch.
    • The change saves immediately with a toast notification.
  • Method 2: Staged Changes (Edit Mode)
    1. Click the Edit icon ( ) on the Client Details panel.
    2. Scroll to “Enabled Servers”. Toggle switches as needed.
    3. Optionally change the client’s Name.
    4. Click the main “Save” button at the bottom. Changes are saved together.

Editing Client Name

  1. Select the client in the sidebar.
  2. Click the Edit icon ( ) in the Right Detail Panel.
  3. Change the Name field.
  4. Optionally adjust server associations.
  5. Click “Save”.

Removing Client Entries

Note: This only removes the client entry from OneServer’s list. It does not uninstall the client application itself. It’s recommended to uninstall the connector first if it’s configured.

  1. Select the client in the sidebar.
  2. Click the Delete icon ( ) in the Right Detail Panel.
  3. Confirm the deletion in the dialog box. A client.deleted event will appear.

Dashboard & Monitoring

The central dashboard area provides high-level views and logs.

Discover Servers Panel

  • Suggests pre-configured server templates (Stdio/SSE).
  • Click the ”+” button on a template card to quickly start the “Add Server” process with pre-filled details and automatic discovery.
  • Installed templates (based on matching command/URL) are marked with a checkmark ( ).

System Events Panel

  • Displays a real-time log of actions within OneServer (server/client changes, connector status, discovery results, errors).
  • Source: Indicates origin (Gateway, System, Connector, Desktop).
  • Event Type: Describes the action (e.g., server.created).
  • Payload: JSON data with details (IDs, names, errors).
  • Interaction:
    • Click an event to see full details in the Right Detail Panel.
    • Use the “Load More Events” button at the bottom (if available) to view older history.
    • Click Refresh ( ) in the header to manually update.
    • Collapse/Expand using the Chevron ( / ) in the header.
  • (Note: Search and filtering capabilities are planned for future versions).
Getting Started Settings