@eduware/oneroster 1.1.0 → 1.2.1

package/README.md

@@ -513,7 +513,9 @@ See [FUNCTIONS.md](./FUNCTIONS.md) for the complete list of standalone functions
 
 ## MCP Server
 
-This SDK includes an MCP (Model Context Protocol) server for AI applications:
+This SDK includes an MCP (Model Context Protocol) server for AI applications. The MCP server exposes OneRoster API operations as tools that can be used by AI assistants.
+
+### Basic Configuration (OAuth 2.0)
 
 ```json
 {
@@ -527,6 +529,8 @@ This SDK includes an MCP (Model Context Protocol) server for AI applications:
                 "--",
                 "mcp",
                 "start",
+                "--server-url",
+                "https://your-oneroster-server.com",
                 "--client-id",
                 "your-client-id",
                 "--client-secret",
@@ -539,6 +543,95 @@ This SDK includes an MCP (Model Context Protocol) server for AI applications:
 }
 ```
 
+### ClassLink Configuration (Bearer Token)
+
+For ClassLink's proxy mode with pre-authenticated bearer tokens:
+
+```json
+{
+    "mcpServers": {
+        "OneRoster": {
+            "command": "npx",
+            "args": [
+                "-y",
+                "--package",
+                "@eduware/oneroster",
+                "--",
+                "mcp",
+                "start",
+                "--server-url",
+                "https://oneroster-proxy.apis.classlink.com/YOUR_TENANT_ID",
+                "--auth-type",
+                "bearer",
+                "--bearer-token",
+                "your-bearer-token",
+                "--client-profile",
+                "classlink"
+            ]
+        }
+    }
+}
+```
+
+### OAuth 1.0a Configuration (OneRoster v1.1)
+
+For OneRoster v1.1 servers using OAuth 1.0a:
+
+```json
+{
+    "mcpServers": {
+        "OneRoster": {
+            "command": "npx",
+            "args": [
+                "-y",
+                "--package",
+                "@eduware/oneroster",
+                "--",
+                "mcp",
+                "start",
+                "--server-url",
+                "https://your-oneroster-server.com",
+                "--auth-type",
+                "oauth1",
+                "--oneroster-version",
+                "1.1",
+                "--client-id",
+                "your-client-id",
+                "--client-secret",
+                "your-client-secret"
+            ]
+        }
+    }
+}
+```
+
+### Command Line Arguments
+
+| Argument              | Description                                                   | Default   | Required          |
+| --------------------- | ------------------------------------------------------------- | --------- | ----------------- |
+| `--server-url`        | OneRoster API server URL                                      | —         | Yes               |
+| `--auth-type`         | Authentication type: `oauth1`, `oauth2`, or `bearer`          | `oauth2`  | No                |
+| `--client-id`         | OAuth client ID                                               | —         | For oauth1/oauth2 |
+| `--client-secret`     | OAuth client secret                                           | —         | For oauth1/oauth2 |
+| `--token-url`         | OAuth 2.0 token endpoint URL                                  | —         | For oauth2        |
+| `--bearer-token`      | Pre-authenticated bearer token                                | —         | For bearer        |
+| `--client-profile`    | Client profile: `full` (all tools) or `classlink` (read-only) | `full`    | No                |
+| `--oneroster-version` | OneRoster API version: `1.1` or `1.2`                         | `1.2`     | No                |
+| `--transport`         | Transport protocol: `stdio` or `sse`                          | `stdio`   | No                |
+| `--port`              | Port for SSE transport                                        | `2718`    | No                |
+| `--tool`              | Specific tools to mount (repeatable)                          | All tools | No                |
+| `--log-level`         | Log level: `debug`, `info`, `warn`, `error`                   | `info`    | No                |
+| `--env`               | Environment variables (format: `KEY=value`, repeatable)       | —         | No                |
+
+### Client Profiles
+
+The `--client-profile` flag restricts which tools are available:
+
+- **`full`** (default): All OneRoster tools including create, update, and delete operations
+- **`classlink`**: Read-only tools matching ClassLink's supported endpoints
+
+Using the appropriate profile prevents AI assistants from attempting unsupported operations.
+
 ## Runtime Support
 
 - **Browsers:** Chrome, Safari, Edge, Firefox (evergreen)