Skip to content

Document MCPJam MCP server tools #1866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document MCPJam MCP server tools #1866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/hosted/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,45 @@ Try it yourself with the [Excalidraw MCP server](https://app.mcpjam.com/shared/e
3. Choose your authentication method (None, Bearer Token, or OAuth 2.0)
4. Start inspecting tools, resources, and prompts

## MCPJam MCP server

MCPJam provides a hosted MCP server at `https://mcp.mcpjam.com/mcp` (production) and `https://mcp-staging.mcpjam.com/mcp` (staging). Connect to it from any MCP client to access your MCPJam workspaces, organizations, and run diagnostics on your servers.

### Authentication

The server uses OAuth 2.0 with WorkOS AuthKit. When you connect from an MCP client, it will automatically discover the authorization server and guide you through the OAuth flow using your MCPJam account.

### Available tools

- **`whoami`** — Returns your authenticated MCPJam user record
- **`getWorkspaces`** — Lists your workspaces, optionally filtered by organization
- **`getOrg`** — Returns details for a specific organization you belong to
- **`doctor`** — Runs diagnostics on MCP servers in a workspace

Use `getWorkspaces` and `getOrg` to discover the IDs needed for `doctor`.

### Example usage

```bash
# Connect from any MCP client
# The client will auto-discover OAuth and prompt you to sign in

# List all your workspaces
getWorkspaces {}

# List workspaces in a specific organization
getWorkspaces { "organizationId": "org_123" }

# Get organization details
getOrg { "organizationId": "org_123" }

# Run diagnostics on servers in a workspace
doctor {
"organizationId": "org_123",
"workspaceId": "ws_456"
}
```

## What's different

The following features are not available in the hosted app. They are available when running MCPJam locally via [npx, Docker, or the desktop app](/installation).
Expand Down
Loading