Skip to main content
Glama
pipeshub-ai

PipesHub MCP Server

Official

MCPクライアントをPipesHub MCPサーバーに接続する

このガイドでは、PipesHubのリモートMCPサーバーをCursor、Claude Code、Gemini CLI、Codex CLI、Claude.ai(Web)、LibreChatに、静的OAuth認証情報またはベアラートークンを使用して接続する方法を説明します。

PipesHubは、Streamable HTTPを介して/mcpにリモートMCPエンドポイントを公開します。MCPクライアントはこのエンドポイントに直接接続します。ローカルのnpmパッケージやstdioプロセスは不要です。

コーディングエージェントですか? コーディングエージェント向けから始めてください。npx skills add pipeshub-ai/mcp-serverでスキルをユーザーのリポジトリにインストールします(skills/pipeshubを参照)。このリポジトリのコントリビューターは、AGENTS.mdをお読みください。

ツールリファレンスをお探しですか? TOOLS.mdで、MCPサーバーが公開する各ツール(pipeshub_chat、pipeshub_search、pipeshub_get_record_content、pipeshub_download_record、pipeshub_directory、pipeshub_sources、pipeshub_agents)の説明、引数、および判断ガイドを参照してください。

QMを使用していますか? QMはサードパーティのMCPエンドポイントを接続できません。QMは独自のハーネスに対するMCPサーバーであり、クライアントではないためです。QMでPipesHubを使用するに従ってください。qm/内のデプロイメント層バンドルは、エージェントのサンドボックス内でpipeshubコマンドを提供します。このパッケージはそのコマンドを2番目のbinとして同梱しています。

前提条件

  • 実行中のPipesHubインスタンス(セルフホストまたはクラウド)

  • PipesHubで作成したOAuthアプリ(ステップ1を参照)

Related MCP server: AnythingLLM MCP Server

ステップ1: PipesHubでOAuthアプリを作成する

  1. 管理者としてPipesHubインスタンスにログインします

  2. 設定 > 開発者設定 > OAuthアプリに移動します

  3. OAuthアプリを作成をクリックします

  4. アプリの詳細を入力します:

    • 名前:例:MCP Integration

    • リダイレクトURI:使用予定のクライアントのリダイレクトURIをすべて追加します:

      クライアント

      リダイレクトURI

      Cursor

      cursor://anysphere.cursor-mcp/oauth/callback

      Claude Code

      http://localhost:<PORT>/callback(例:http://localhost:8080/callback)

      Claude.ai(Web)

      https://claude.ai/api/mcp/auth_callback

      Gemini CLI

      http://localhost:7777/oauth/callback

      LibreChat

      http://localhost:3080/api/mcp/<server-identifier>/oauth/callback

重要:MCP_SCOPESのスコープは、OAuthアプリに付与されたスコープと一致している必要があります。不一致があると認可エラーが発生します。

  1. アプリを保存し、クライアントIDとクライアントシークレットをコピーします

デフォルトスコープのカスタマイズ

デフォルトでは、PipesHubは/.well-known/oauth-protected-resource/mcpディスカバリーエンドポイントでいくつかのデフォルトスコープを公開します。公開するスコープは、PipesHubインスタンスでMCP_SCOPES環境変数を設定することでカスタマイズできます。これは、公開されているすべてのスコープを自動的に要求するClaude Codeなどのクライアントに役立ちます。

プレースホルダー

以下のすべての設定で、これらを置き換えてください:

プレースホルダー

説明

例

PIPESHUB_INSTANCE_URL

PipesHubインスタンスのURL

https://app.pipeshub.com

YOUR_CLIENT_ID

OAuthアプリのクライアントID

clid_abc123...

YOUR_CLIENT_SECRET

OAuthアプリのクライアントシークレット

clsec_xyz789...

リモートMCPエンドポイントのURLは次のとおりです:PIPESHUB_INSTANCE_URL/mcp


リモートMCPのセットアップ

Cursorは、mcp.jsonのauthオブジェクトを介してリモートMCPサーバーの静的OAuthをサポートしています。

設定

Cursor設定 > ツールとインテグレーション > 新しいMCPサーバーを開くか、プロジェクトの.cursor/mcp.jsonを編集します:

{
  "mcpServers": {
    "pipeshub": {
      "url": "PIPESHUB_INSTANCE_URL/mcp",
      "auth": {
        "CLIENT_ID": "YOUR_CLIENT_ID",
        "CLIENT_SECRET": "YOUR_CLIENT_SECRET",
        "scopes": [
          "org:read", "org:write", "org:admin",
          "user:read", "user:write", "user:invite", "user:delete",
          "usergroup:read", "usergroup:write",
          "team:read", "team:write",
          "kb:read", "kb:write", "kb:delete", "kb:upload",
          "semantic:read", "semantic:write", "semantic:delete",
          "conversation:read", "conversation:write", "conversation:chat",
          "agent:read", "agent:write", "agent:execute",
          "connector:read", "connector:write", "connector:sync", "connector:delete",
          "config:read", "config:write",
          "document:read", "document:write", "document:delete",
          "crawl:read", "crawl:write", "crawl:delete"
        ]
      }
    }
  }
}

Cursorは、PipesHubの/.well-known/oauth-protected-resource/mcpメタデータを介して認可エンドポイントとトークンエンドポイントを自動検出します。

注: scopesフィールドを省略すると、Cursorは/.well-known/oauth-protected-resource/mcpを取得し、そこにリストされているすべてのscopes_supportedを要求します。アクセスを制限するには、必要なスコープのみを明示的にリストしてください。サーバー側で公開するスコープを制御することもできます。デフォルトスコープのカスタマイズを参照してください。

環境変数の使用

Cursorの${env:VAR}補間を使用して、設定ファイルからシークレットを除外します:

{
  "mcpServers": {
    "pipeshub": {
      "url": "${env:PIPESHUB_INSTANCE_URL}/mcp",
      "auth": {
        "CLIENT_ID": "${env:PIPESHUB_CLIENT_ID}",
        "CLIENT_SECRET": "${env:PIPESHUB_CLIENT_SECRET}",
        "scopes": [
          "kb:read", "kb:write",
          "semantic:read", "semantic:write",
          "conversation:read", "conversation:write", "conversation:chat",
          "agent:read", "agent:write", "agent:execute",
          "connector:read", "connector:write",
          "config:read", "user:read"
        ]
      }
    }
  }
}

リダイレクトURI

Cursorは、すべてのMCPサーバーに対して固定のリダイレクトURIを使用します:

cursor://anysphere.cursor-mcp/oauth/callback

PipesHubでOAuthアプリを作成する際に、これを許可されたリダイレクトURIとして登録してください。

OAuthログインのトラブルシューティング

Cursorの内部ブラウザがOAuthログインページを読み込めない場合は、内部ブラウザから認可URLをコピーして通常のブラウザに貼り付け、ログインフローを完了してください。

Claude Codeは、--client-id、--client-secret、--callback-portを介して、静的OAuth認証情報を使用したリモートHTTP MCPサーバーをサポートしています。

PipesHubは/.well-known/oauth-protected-resource/mcpでディスカバリーを公開しているため、Claude Codeは認可エンドポイントとトークンエンドポイントを自動検出します。

重要: Claude Codeは特定のスコープの設定をサポートしていません。/.well-known/oauth-protected-resource/mcpを取得し、scopes_supportedリストを読み取り、すべてを要求します。PipesHubのOAuthアプリは、ディスカバリーエンドポイントにリストされているすべてのスコープにアクセスできる必要があります。そうしないと、認可リクエストは失敗します。公開するスコープを制限するには、デフォルトスコープのカスタマイズを参照してください。

CLIで追加

claude mcp add --transport http \
  --client-id YOUR_CLIENT_ID \
  --client-secret \
  --callback-port 8080 \
  pipeshub PIPESHUB_INSTANCE_URL/mcp

--client-secretを値なしで指定すると、マスクされた入力が求められます。プロンプトをスキップするには、MCP_CLIENT_SECRET環境変数を設定します:

MCP_CLIENT_SECRET=YOUR_CLIENT_SECRET claude mcp add --transport http \
  --client-id YOUR_CLIENT_ID \
  --client-secret \
  --callback-port 8080 \
  pipeshub PIPESHUB_INSTANCE_URL/mcp

すべてのプロジェクトで使用できるようにするには:

claude mcp add --transport http --scope user \
  --client-id YOUR_CLIENT_ID \
  --client-secret \
  --callback-port 8080 \
  pipeshub PIPESHUB_INSTANCE_URL/mcp

JSONで追加

claude mcp add-json pipeshub '{
  "type": "http",
  "url": "PIPESHUB_INSTANCE_URL/mcp",
  "oauth": {
    "clientId": "YOUR_CLIENT_ID",
    "callbackPort": 8080
  }
}' --client-secret

プロジェクトスコープ(.mcp.json)

プロジェクトのルートに.mcp.jsonファイルを作成します。これはバージョン管理にコミットできます(シークレットは環境変数で外部に保持されます):

{
  "mcpServers": {
    "pipeshub": {
      "type": "http",
      "url": "${PIPESHUB_INSTANCE_URL}/mcp",
      "oauth": {
        "clientId": "${PIPESHUB_CLIENT_ID}",
        "callbackPort": 8080
      }
    }
  }
}

Claude Codeを起動する前に環境変数を設定します:

export PIPESHUB_INSTANCE_URL="https://app.pipeshub.com"
export PIPESHUB_CLIENT_ID="your-client-id"

注: クライアントシークレットは設定ファイルではなく、システムのキーチェーンに保存されます。/mcpで初めて認証する際に入力を求められます。

認証

サーバーを追加した後、Claude Code内で/mcpを実行し、ブラウザのログインフローに従います。トークンは安全に保存され、自動的に更新されます。

確認

claude mcp list
claude mcp get pipeshub

Gemini CLIは、dynamic_discovery(デフォルト)を介してOAuthを使用したリモートMCPサーバーをサポートしています。これは、PipesHubの/.well-known/oauth-protected-resource/mcpから認可エンドポイントとトークンエンドポイントを自動検出します。

オプションA:設定ファイル

~/.gemini/settings.jsonを編集します:

{
  "mcpServers": {
    "pipeshub": {
      "url": "PIPESHUB_INSTANCE_URL/mcp",
      "oauth": {
        "clientId": "YOUR_CLIENT_ID",
        "clientSecret": "YOUR_CLIENT_SECRET",
        "scopes": [
          "org:read", "org:write", "org:admin",
          "user:read", "user:write", "user:invite", "user:delete",
          "usergroup:read", "usergroup:write",
          "team:read", "team:write",
          "kb:read", "kb:write", "kb:delete", "kb:upload",
          "semantic:read", "semantic:write", "semantic:delete",
          "conversation:read", "conversation:write", "conversation:chat",
          "agent:read", "agent:write", "agent:execute",
          "connector:read", "connector:write", "connector:sync", "connector:delete",
          "config:read", "config:write",
          "document:read", "document:write", "document:delete",
          "crawl:read", "crawl:write", "crawl:delete"
        ]
      }
    }
  }
}

注: scopesリストを、OAuthアプリに付与されたスコープに合わせて調整してください。ツールのサブセットのみが必要な場合は、それに応じてスコープを制限できます。

オプションB:CLIコマンド

gemini mcp add --transport http pipeshub PIPESHUB_INSTANCE_URL/mcp

次に、~/.gemini/settings.jsonを編集して、上記のようにoauthブロックを追加します。

認証

Gemini CLI内で、/mcp authコマンドを使用します:

# List servers and their auth status
/mcp auth

# Authenticate with PipesHub (opens browser for login)
/mcp auth pipeshub

# Re-authenticate if tokens expire
/mcp auth pipeshub

初回接続時に、Geminiは401レスポンスを自動的に検出し、OAuthエンドポイントを発見して、ログイン用のブラウザを開きます。トークンは~/.gemini/mcp-oauth-tokens.jsonに安全に保存され、自動的に更新されます。

サーバーの管理

# List all configured servers
gemini mcp list

# Remove the server
gemini mcp remove pipeshub

# Temporarily disable/enable
gemini mcp disable pipeshub
gemini mcp enable pipeshub

OAuth設定プロパティ

プロパティ

必須

説明

clientId

はい

PipesHubのOAuth 2.0クライアントID

clientSecret

いいえ

OAuth 2.0クライアントシークレット(機密クライアント用)

scopes

いいえ

要求するOAuthスコープ

authorizationUrl

いいえ

認可エンドポイントの上書き(デフォルトでは自動検出)

tokenUrl

いいえ

トークンエンドポイントの上書き(デフォルトでは自動検出)

redirectUri

いいえ

リダイレクトURIの上書き(デフォルトはhttp://localhost:7777/oauth/callback)

注: OAuthにはローカルブラウザが必要です。ヘッドレス環境、X11転送のないリモートSSH、ブラウザアクセスのないコンテナでは機能しません。

Codex CLI(OpenAI Codex)は、Streamable HTTPを介してリモートMCPサーバーに接続します。~/.codex/config.toml(またはプロジェクトルートの.codex/config.tomlでプロジェクト単位にスコープ)の[mcp_servers.<name>]テーブルで設定します。CodexのHTTPトランスポートは、環境変数から読み取られるベアラートークンで認証するため、PipesHubのJWTベアラートークンを渡します。

[mcp_servers.pipeshub]
url = "PIPESHUB_INSTANCE_URL/mcp"
bearer_token_env_var = "PIPESHUB_BEARER_TOKEN"

bearer_token_env_varは、トークンを保持する環境変数の名前です。Codexを起動する前にエクスポートします:

export PIPESHUB_BEARER_TOKEN="YOUR_BEARER_TOKEN"

トークンはBearerキーワードなしの生のJWTです。

または、CLIで追加します:

codex mcp add pipeshub \
  --url PIPESHUB_INSTANCE_URL/mcp \
  --bearer-token-env-var PIPESHUB_BEARER_TOKEN

--bearer-token-env-varは、トークン値そのものではなく、トークンを保持する環境変数の名前を受け取ります。

確認

# List configured MCP servers
codex mcp list

# Inside the Codex TUI, view server status and available tools
/mcp

Claude.aiは、リモートMCPサーバーを介したカスタムコネクタをサポートしています。これにより、ローカル設定なしでClaude.aiのWebインターフェースでPipesHubツールを直接使用できます。

注: この機能は現在ベータ版です。無料プランのユーザーはカスタムコネクタを1つに制限されています。

Claude.aiコネクタ設定

Claude.aiカスタムコネクタ追加ダイアログ

個人ユーザー向け(Pro / Maxプラン)

  1. claude.aiにアクセスし、設定 > コネクタに移動します

  2. コネクタセクションの下部にあるカスタムコネクタを追加をクリックします

  3. MCPサーバーのURLを入力します:

    PIPESHUB_INSTANCE_URL/mcp
  4. 詳細設定をクリックし、OAuth認証情報を入力します:

    • OAuthクライアントID:YOUR_CLIENT_ID

    • OAuthクライアントシークレット:YOUR_CLIENT_SECRET

  5. 追加をクリックします

  6. PipesHubのログインページにリダイレクトされ、認証と権限の付与を行います

  7. 認証後、コネクタがアクティブになり、PipesHubツールがClaude.aiの会話で利用できるようになります

チーム / エンタープライズプラン向け

組織のオーナーが最初にコネクタを追加する必要があります:

  1. 組織設定 > コネクタに移動します

  2. カスタムコネクタを追加をクリックします

  3. MCPサーバーのURLを入力します:PIPESHUB_INSTANCE_URL/mcp

  4. 詳細設定をクリックし、OAuthクライアントIDとクライアントシークレットを入力します

  5. 追加をクリックします

チームメンバーはその後接続できます:

  1. 設定 > コネクタに移動します

  2. PipesHubコネクタ(「カスタム」ラベル付き)を見つけます

  3. 接続をクリックして、PipesHubのOAuthログインで認証します

リダイレクトURI

Claude.aiはOAuthに次のリダイレクトURIを使用します:

https://claude.ai/api/mcp/auth_callback

これをPipesHubのOAuthアプリで許可されたリダイレクトURIとして登録してください。

セキュリティに関する注意事項

  • 信頼できるMCPサーバーにのみ接続してください

  • OAuth認証フロー中に要求される権限を確認してください

  • Claude.aiは付与されたOAuthトークンを使用してあなたの代わりにPipesHubとやり取りします。パスワードが共有されることはありません

LibreChatは、カスタムコネクタUIを介してOAuth認証を使用したリモートMCPサーバーをサポートしています。これにより、LibreChatインスタンスで利用可能な任意のモデルにPipesHubツールを接続できます。

LibreChat MCP設定

設定

  1. LibreChatインスタンスにログインします

  2. MCP Servers設定パネルに移動します

  3. Addをクリックして新しいカスタムMCPコネクタを作成します

  4. コネクタの詳細を入力します:

    • Name:Pipeshub(または任意の名前)

    • MCP Server URL:PIPESHUB_INSTANCE_URL/mcp

    • Transport:Streamable HTTPSを選択

    • Authentication:OAuthを選択

  5. OAuth認証情報を入力します:

    • Client ID:YOUR_CLIENT_ID

    • Client Secret:YOUR_CLIENT_SECRET

    • Authorization URL:PIPESHUB_INSTANCE_URL/api/v1/oauth2/authorize

    • Token URL:PIPESHUB_INSTANCE_URL/api/v1/oauth2/token

    • Scope:openid email(または必要に応じて追加のスコープ)

  6. I trust this applicationにチェックを入れます

  7. Addをクリックしてコネクタを保存します

  8. 追加後、LibreChatはコネクタ設定パネル(コピーボタンの横)にRedirect URIを生成して表示します。形式は次のとおりです:

    http://localhost:3080/api/mcp/<server-identifier>/oauth/callback
  9. Redirect URIをコピーし、PipesHub OAuthアプリの許可されたリダイレクトURIとして登録します(ステップ1を参照)

  10. LibreChatのコネクタに戻り、UpdateをクリックしてOAuthフローを開始します — PipesHubのログインページにリダイレクトされ、認証と権限の付与を行います

Redirect URI

LibreChatはコネクタ作成後にリダイレクトURIを生成します。URIの形式は次のとおりです:

http://localhost:3080/api/mcp/<server-identifier>/oauth/callback

<server-identifier>はLibreChatが割り当てる一意の識別子です(コネクタ設定の上部に「Unique Server Identifier」として表示されます)。このURIをコピーし、認証前にPipesHub OAuthアプリの許可されたリダイレクトURIに追加する必要があります。

注: LibreChatインスタンスが別のホストやポートで実行されている場合、URIはそれを反映します(例:https://chat.example.com/api/mcp/pipeshub/oauth/callback)。

Scopes

LibreChatでは、ScopeフィールドでOAuthスコープを指定できます。スペース区切りのリストを使用します:

openid email

PipesHub固有のスコープを要求するには、スコープフィールドに追加します:

openid email org:read kb:read kb:write semantic:read conversation:read conversation:write conversation:chat agent:read agent:execute

注: 要求するスコープは、PipesHubでOAuthアプリに付与されたスコープと一致している必要があります。詳細はデフォルトスコープのカスタマイズを参照してください。


ローカルMCPサーバー(Stdio)

PipesHubのリモートMCPエンドポイントに接続する代わりに、@pipeshub-ai/mcp npmパッケージを使用してMCPサーバーをローカルのstdioプロセスとして実行できます。これは、ローカルセットアップを好む場合や、リモートMCPエンドポイントへの直接HTTP接続が現実的でない環境で作業する必要がある場合に便利です。

前提条件

  • Node.js 18以上がインストールされていること

  • PipesHubインスタンスのURL

  • 認証情報:Bearerトークン(JWT)またはOAuth Client ID + Secret

プレースホルダー

以下のすべての設定で、これらを置き換えてください:

プレースホルダー

説明

例

PIPESHUB_INSTANCE_URL

PipesHubインスタンスのURL

https://app.pipeshub.com

YOUR_BEARER_TOKEN

認証用のJWT Bearerトークン

eyJhbGci...

YOUR_CLIENT_ID

OAuthアプリのクライアントID

clid_abc123...

YOUR_CLIENT_SECRET

OAuthアプリのクライアントシークレット

clsec_xyz789...

Claude Desktopの設定(claude_desktop_config.json)で構成します:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--bearer-auth",
        "YOUR_BEARER_TOKEN"
      ]
    }
  }
}

OAuth認証情報を使用する場合:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--client-id",
        "YOUR_CLIENT_ID",
        "--client-secret",
        "YOUR_CLIENT_SECRET",
        "--token-url",
        "/api/v1/oauth2/token"
      ]
    }
  }
}

Cursor Settings > Tools and Integrations > New MCP Serverを開くか、プロジェクトの.cursor/mcp.jsonを編集します:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--bearer-auth",
        "YOUR_BEARER_TOKEN"
      ]
    }
  }
}

OAuth認証情報を使用する場合:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--client-id",
        "YOUR_CLIENT_ID",
        "--client-secret",
        "YOUR_CLIENT_SECRET",
        "--token-url",
        "/api/v1/oauth2/token"
      ]
    }
  }
}
claude mcp add pipeshub -- npx -y @pipeshub-ai/mcp start \
  --server-url PIPESHUB_INSTANCE_URL \
  --bearer-auth YOUR_BEARER_TOKEN

OAuth認証情報を使用する場合:

claude mcp add pipeshub -- npx -y @pipeshub-ai/mcp start \
  --server-url PIPESHUB_INSTANCE_URL \
  --client-id YOUR_CLIENT_ID \
  --client-secret YOUR_CLIENT_SECRET \
  --token-url /api/v1/oauth2/token
gemini mcp add pipeshub -- npx -y @pipeshub-ai/mcp start \
  --server-url PIPESHUB_INSTANCE_URL \
  --bearer-auth YOUR_BEARER_TOKEN

OAuth認証情報を使用する場合:

gemini mcp add pipeshub -- npx -y @pipeshub-ai/mcp start \
  --server-url PIPESHUB_INSTANCE_URL \
  --client-id YOUR_CLIENT_ID \
  --client-secret YOUR_CLIENT_SECRET \
  --token-url /api/v1/oauth2/token

MCPサーバーをローカルのstdioプロセスとして実行し、OAuthアプリのClient IDとSecret(client_credentialsグラント)で認証します。~/.codex/config.toml(またはプロジェクトルートの.codex/config.toml)を編集します:

[mcp_servers.pipeshub]
command = "npx"
args = [
  "-y",
  "@pipeshub-ai/mcp",
  "start",
  "--server-url",
  "PIPESHUB_INSTANCE_URL/api/v1",
  "--client-id",
  "YOUR_CLIENT_ID",
  "--client-secret",
  "YOUR_CLIENT_SECRET",
  "--token-url",
  "/api/v1/oauth2/token",
]

注意:

  • --server-urlには/api/v1を含める必要があります。

  • --token-url /api/v1/oauth2/tokenが必要です。

または、代わりにJWT Bearerトークンで認証します:

[mcp_servers.pipeshub]
command = "npx"
args = [
  "-y",
  "@pipeshub-ai/mcp",
  "start",
  "--server-url",
  "PIPESHUB_INSTANCE_URL/api/v1",
  "--bearer-auth",
  "YOUR_BEARER_TOKEN",
]

コマンドパレット > MCP: Open User Configurationを開き、次を追加します:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--bearer-auth",
        "YOUR_BEARER_TOKEN"
      ]
    }
  }
}

Windsurf Settings > Cascade > Manage MCPs > View raw configを開き、次を追加します:

{
  "mcpServers": {
    "pipeshub": {
      "command": "npx",
      "args": [
        "@pipeshub-ai/mcp",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--bearer-auth",
        "YOUR_BEARER_TOKEN"
      ]
    }
  }
}

npmパッケージの代わりにクローンしたリポジトリからローカルMCPサーバーを実行する場合:

git clone https://github.com/pipeshub-ai/pipeshub-ai.git
cd pipeshub-ai
npm install
npm run build
node ./bin/mcp-server.js start --server-url PIPESHUB_INSTANCE_URL --bearer-auth YOUR_BEARER_TOKEN

MCPクライアント設定では、npx @pipeshub-ai/mcpをnode ./bin/mcp-server.jsに置き換えます:

{
  "mcpServers": {
    "pipeshub": {
      "command": "node",
      "args": [
        "./bin/mcp-server.js",
        "start",
        "--server-url",
        "PIPESHUB_INSTANCE_URL",
        "--bearer-auth",
        "YOUR_BEARER_TOKEN"
      ]
    }
  }
}

MCP Inspectorでデバッグする場合:

npx @modelcontextprotocol/inspector node ./bin/mcp-server.js start --server-url PIPESHUB_INSTANCE_URL --bearer-auth YOUR_BEARER_TOKEN

CLIヘルプ

サーバー引数の完全なリスト:

npx @pipeshub-ai/mcp --help

動作の仕組み

アーキテクチャ

AI Client (Cursor / Claude Code / Gemini CLI / Codex CLI / Claude.ai / LibreChat)
        │
        │  HTTP POST (JSON-RPC)
        │  Authorization: Bearer <token>
        ▼
  PIPESHUB_INSTANCE_URL/mcp
        │
        │  StreamableHTTP Transport
        │  (stateless, per-request MCP server)
        ▼
  PipesHub API (curated tool set — see TOOLS.md)

OAuth保護リソースのディスカバリー

PipesHubは、次の場所でOAuth保護リソースのディスカバリーを公開しています:

PIPESHUB_INSTANCE_URL/.well-known/oauth-protected-resource/mcp

これにより、すべてのOAuthエンドポイントが自動的に返されます:

  • 認可:PIPESHUB_INSTANCE_URL/api/v1/oauth2/authorize

  • トークン:PIPESHUB_INSTANCE_URL/api/v1/oauth2/token

  • 失効:PIPESHUB_INSTANCE_URL/api/v1/oauth2/revoke

  • JWKS:PIPESHUB_INSTANCE_URL/.well-known/jwks.json


トラブルシューティング

「Incompatible auth server: does not support dynamic client registration」

これは、クライアントが事前設定された認証情報を使用する代わりに動的登録を試みていることを意味します。--client-idと--client-secret(Claude Code)またはauthオブジェクト(Cursor)を正しく渡したことを確認してください。

認証失敗 / リダイレクトエラー

  • OAuthアプリのRedirect URIがクライアントが使用するものと完全に一致していることを確認してください:

    • Cursor:cursor://anysphere.cursor-mcp/oauth/callback

    • Claude Code:http://localhost:<callbackPort>/callback

    • Claude.ai:https://claude.ai/api/mcp/auth_callback

    • Gemini CLI:http://localhost:7777/oauth/callback

    • LibreChat:http://localhost:3080/api/mcp/<server-identifier>/oauth/callback

  • OAuthアプリがPipesHubでアクティブ(停止されていない)であることを確認してください

MCPエンドポイントに到達できない

  • エンドポイントにアクセスできることを確認します:curl -X POST PIPESHUB_INSTANCE_URL/mcp(接続エラーではなく401が返されるはずです)

  • PipesHubインスタンスでMCPが有効になっていることを確認します

MCP Inspectorでのデバッグ

npx @modelcontextprotocol/inspector

次に、Bearerトークンを使用してPIPESHUB_INSTANCE_URL/mcpに接続し、エンドポイントを直接テストします。


FAQ

  1. PipesHubインスタンスのMCP_SCOPES環境変数を更新して、ディスカバリーエンドポイント経由で公開する新しいスコープを含めます。

  2. PipesHubでOAuthアプリのスコープを更新します:Settings > Developer Settings > OAuth Appsに移動し、OAuthアプリを選択して、必要に応じてスコープを追加または削除します。

  3. クライアントを再認証します — 既存のトークンには古いスコープが含まれているため、更新されたスコープで新しいトークンを取得するには再認証が必要です。例:

    • Cursor:MCPサーバーを削除して再追加するか、キャッシュされたOAuthトークンをクリアして再接続します。

    • Claude Code:/mcpを実行し、ブラウザのログインフローを再度完了します。

    • Gemini CLI:/mcp auth pipeshubを実行して再認証します。

    • Codex CLI:PIPESHUB_BEARER_TOKENを新しいトークンで更新し、Codexを再起動します。

    • Claude.ai:Settings > Connectorsでコネクタを切断して再接続します。

Available Tools

7 tools
pipeshub_agentsA
Read-onlyIdempotent

List the PipesHub agents configured for this org, each with its capabilities.

Agents are specialized assistants (custom system prompt, tools, knowledge scope). To converse with one, take its agentId and pass it to pipeshub_chat's agentId argument.

Each agent is returned as: { agentId, name, description, systemPrompt, startMessage, tags, webSearch, isActive, toolsets, knowledge }.

  • toolsets — what the agent can DO: each { name, tools } where name is the connector (e.g. jira, gmail) and tools are the runnable tool ids (e.g. jira.create_issue, gmail.send_email).

  • knowledge — what the agent can READ: each { name, type } (e.g. Confluence-2 / Confluence).

Route on toolsets/knowledge, not the name — names and descriptions are often generic or misleading. Match the request to the agent whose tools can actually perform it (e.g. "create a Jira ticket" → the agent whose toolset is jira and whose tools include jira.create_issue). If NO agent has a tool for the requested action, say so — don't force an unrelated agent.

The list may be empty (no agents configured). For plain Q&A when no specific agent is needed, use pipeshub_chat WITHOUT agentId and pick a chatMode: internal_search (org's indexed knowledge) or web_search (live web). Use agentId everywhere an agent is referenced.

ParametersJSON Schema
NameRequiredDescriptionDefault
searchNoOptional case-insensitive substring match across agent name, description, and tags. Omit to return every agent.

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnly/idempotent annotations, the description discloses that the list may be empty, reveals the exact return object shape, explains the semantics of toolsets and knowledge, and warns that names/descriptions can be misleading. This is rich behavioral context that helps the agent interpret results correctly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is longer than typical, but every section earns its place: purpose, return structure, field semantics, routing guidance, and empty-list caveat. The use of bullets and bolded field names keeps it scannable and front-loaded with the core purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having no output schema, the description fully compensates by detailing the return object, nested structures, and field meanings. It also covers edge cases (empty list, misleading names) and alternatives, making it complete for an agent to invoke and interpret correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already fully documents the single search parameter with 100% coverage, including case-insensitivity, substring matching, and omit behavior. The description adds no further parameter-level detail, so the baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'List the PipesHub agents configured for this org, each with its capabilities.' It also clearly differentiates this tool from siblings like pipeshub_chat by explaining that this is for listing agents, not conversing with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit routing instructions: use this tool to discover agents, take the agentId, and pass it to pipeshub_chat; for plain Q&A use pipeshub_chat without agentId. It also states when to refrain from forcing an unrelated agent, providing clear when-to-use and when-not-to-use guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

pipeshub_chatA

Ask a question, get an answer grounded in the org's indexed data with citations. It reads a few retrieved passages — never a whole document, never a complete list.

Three questions this tool gets WRONG. Check them first:

  • Structure — "what's under this epic?", "which pages are in this space?", "what links to this ticket?", "what's in this folder?" → pipeshub_get_record_content mode:"navigate". Ranking cannot see how records relate.

  • Exhaustive — "how many X?", "list ALL the Y", "every Z" → mode:"navigate", which reports the group's real total. This tool undercounts and will not say so.

  • One named document — summarize it, extract from it, what does it say about X → pipeshub_search for the recordId, then mode:"content".

Everything else about the org's knowledge belongs here: policies, processes, decisions, history, "what do we know about X", and any question spanning several documents.

Internal search (default, chatMode: "internal_search"): the user's documents, files, knowledge base, company policies — anything in their PipesHub-indexed sources (Drive, Box, Confluence, Slack, Gmail, Jira, the org's KB, ...).

Web search (chatMode: "web_search"): current events or public information unlikely to be in the org's knowledge base.

Both are plain-chat modes. Agent chat — pass an agentId from pipeshub_agents — runs against that agent's own prompt, tools and knowledge; quick is its only mode, requires the agentId, and is sent automatically.

  • "What's our policy on Y?" → pipeshub_chat (internal_search)

  • "What's in the news about Z?" → pipeshub_chat (web_search)

  • "Find / locate the file named X" → pipeshub_search (then pipeshub_download_record if the user wants the bytes).

Conversation lifecycle — one tool, both start and continue:

  • First turn: omit conversationId. The server creates a new conversation; capture conversationId from the response.

  • Follow-up turn: pass the conversationId from the previous response. Server-side context is preserved — do NOT replay earlier messages, and filters is ignored on follow-ups (set once at creation).

Only re-omit conversationId (start a fresh conversation) when the user explicitly asks to start over / clear context.

The response contains the AI's answer plus citations. To download a cited document, take citations[*].recordId and call pipeshub_download_record.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYesThe user's question or message for this turn.
agentIdNoOptional PipesHub agent to converse with — the `agentId` from `pipeshub_agents`. When set, this turn runs against that agent's configuration (prompt, tools, knowledge). On follow-up turns pass the SAME `agentId` together with the `conversationId` returned by the previous call. Omit for a plain (non-agent) conversation. If unsure which agent to use, call `pipeshub_agents` first to see the options.
filtersNoWhich sources the answer may use. Leave out to use all sources. Only works on the FIRST turn; later turns keep the first turn's sources.
chatModeNoResponse strategy. The valid values depend on whether `agentId` is set: - WITHOUT `agentId` (plain chat): `internal_search` — answer from the org's indexed knowledge (default) — or `web_search` — answer from the live web. - WITH `agentId` (agent chat): `quick` is the only supported mode and is sent automatically, so this argument can be omitted.
modelKeyNoModel id to use (from `pipeshub_sources` `llmModels[*].modelKey`). Defaults to the org's default LLM.
modelNameNo
conversationIdNoExisting conversation id to continue. Omit on the FIRST turn; on every subsequent turn pass the `conversationId` returned by the previous call. Server-side message history is preserved — do NOT replay prior messages.
modelFriendlyNameNo

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond annotations (readOnlyHint=false, openWorldHint=true, destructiveHint=false), the description discloses key behavioral traits: it only reads retrieved passages, never full documents or complete lists; it undercounts and will not say so; filters are ignored on follow-ups; server-side context is preserved so earlier messages must not be replayed. These are critical limitations not captured by annotations, and they directly inform agent decision-making. No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but meticulously structured: core purpose first, then a highlighted 'Three questions this tool gets WRONG' section, followed by 'Everything else... belongs here', internal vs web search, conversation lifecycle, and response handling. Each section is front-loaded with the most important caveats, and every sentence provides actionable guidance. No redundancy or fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers all aspects needed to use the tool correctly: its scope and limitations, the routing to alternative tools, the distinction between chat modes, the conversation lifecycle, parameter usage, and how to handle the response (capture conversationId, use citations to download documents). No output schema exists, but the description explains the response contains 'answer' plus 'citations'. It is complete for a chat tool with this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema coverage is 75%, the description adds substantial semantic depth to parameters. For chatMode it explains the valid values depend on agentId, and that 'quick' is sent automatically when agentId is set. For conversationId it clarifies the lifecycle (omit on first turn, pass on follow-ups, when to re-omit). For filters it notes they only work on the first turn. It also explains how to obtain agentId from pipeshub_agents, and modelKey from pipeshub_sources. This goes far beyond the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb-resource pair: 'Ask a question, get an answer grounded in the org's indexed data with citations.' It also explicitly states what it reads ('a few retrieved passages — never a whole document, never a complete list'), which clearly scopes the tool. It further differentiates itself from siblings by naming three categories of questions it handles poorly and directing to the correct alternatives, making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit when-to-use and when-not-to-use guidance. It lists three question types (structure, exhaustive, one named document) and directs to specific sibling tools, then enumerates what belongs here (policies, processes, decisions, history). It also distinguishes internal_search vs web_search, explains agent chat modes, and gives a complete conversation lifecycle (first turn vs follow-up, when to restart). No ambiguity remains.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

pipeshub_directoryA
Read-onlyIdempotent

Look up people, groups, and teams in PipesHub. Five actions — pick action. Not for documents or files: that is pipeshub_search.

  • whoami — the caller's id, email, full name. Use before get_user on yourself. Errors if the credential is expired or revoked.

  • list_users — page org users; search matches name or email.

  • get_user — full User for one userId.

  • list_groups — org groups with userCount; search matches name.

  • list_my_teams — teams the caller is on, with canEdit / canDelete / canManageMembers; search matches name.

Omit page/limit for the first page (page 1). No match is an empty users/groups/teams array, not an error. pagination.hasNextPage (teams: hasNext) says whether to request the next page.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page for list_* actions. Omit for page 1.
limitNoItems per page for list_* (1–100). Omit for the action default: 50 users, 25 groups, 100 teams.
actionYesWhat to do: - `whoami` — return the authenticated user's identity, confirmed against the server. No other args needed. - `list_users` — paginated list of org users. Optional `page`, `limit`, `search` (substring match against name or email). - `get_user` — full profile for one user. Required `userId`. Use `whoami` to find your own id first if needed. - `list_groups` — paginated list of user groups (with `userCount`). Optional `search` matches group name. - `list_my_teams` — teams the authenticated user belongs to, with capability flags. Optional `search` matches team name.
searchNoSubstring match on list_users (name or email), list_groups (name), and list_my_teams (name). An empty list means no match, not an error.
userIdNoRequired when `action` is `get_user`. 24-character ObjectId. Take it from `whoami` (yourself) or from a `list_users` hit.

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, destructiveHint, but the description adds significant behavioral context: error on expired/revoked credential for whoami, empty arrays for no matches, pagination via hasNextPage/hasNext, and page/limit defaults. No contradictions; the description enriches beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with a clear opening, bulleted action list, and concise pagination/error notes. Every sentence adds value; no fluff. Front-loaded with the primary purpose and sibling differentiation, making it easy to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers all actions, parameters, error conditions, pagination, and alternatives. Even without an output schema, it describes return arrays (users/groups/teams) and capability flags. Nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers all parameters at 100%, so baseline is 3. The description adds cross-parameter dependencies (userId required for get_user, search only applies to list_* actions), clarifies action-specific requirements, and explains pagination behavior. This goes beyond schema, but the schema already provides solid descriptions, so a 4 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Look up people, groups, and teams in PipesHub.' Lists five distinct actions and explicitly differentiates from pipeshub_search for documents/files. An agent can immediately understand scope and distinguish from siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'Not for documents or files: that is pipeshub_search,' naming the alternative and when not to use this tool. Also provides per-action guidance, e.g., 'Use before get_user on yourself' and explains pagination defaults and error behavior. Clear when-to-use and when-not-to-use context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

pipeshub_download_recordA
Read-onlyIdempotent

Download the file as stored for one record — not PipesHub's parsed content, metadata header, or summary.

Use this when the user wants the file itself (download, attach, open). Get recordId from a chat citation or a pipeshub_search hit.

Do not use this to read, summarize, or answer "what does this doc say?" regardless of format. That is pipeshub_get_record_content mode:"content". Text formats come back inline; images, audio, and binary as base64.

convertTo accepts only application/pdf; anything else is ignored.

ParametersJSON Schema
NameRequiredDescriptionDefault
recordIdYesRecord identifier — usually a UUID for connector-sourced records or a 24-character ObjectId for uploaded records. Get it from a chat citation (`citations[*].recordId`) or from a `pipeshub_search` hit.
convertToNoThe only conversion target connectors honour is `application/pdf` (the MIME type, not `pdf`). A bare `pdf` is ignored and the original file is returned with no error. Omit for the file as stored. Does not parse the document — use `pipeshub_get_record_content` `mode:"content"` for that.

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and idempotentHint=true, so the description doesn't need to restate safety. It adds valuable behavioral context: conversion behavior (only application/pdf accepted, bare 'pdf' ignored), output encoding (text inline, binary as base64), and the distinction between stored file and parsed content. No contradiction with annotations. The only minor omission is lack of error handling detail, but that is beyond typical expectations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is moderately long but every sentence serves a distinct purpose: purpose, usage, exclusions, and conversion behavior. It is front-loaded with the core purpose and keeps exclusions and details in later sentences. No filler or redundant phrasing; it earns its length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a download tool with two parameters and no output schema, the description covers everything an agent needs: how to obtain the recordId, what convertTo accepts, output encoding, and what this tool is not for. The sibling references complete the routing. Nothing critical is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented. The description adds value beyond the schema: for recordId, it reiterates the source (citation or search) and clarifies the format expectation; for convertTo, it explains that only 'application/pdf' is honored and that 'pdf' is silently ignored. This extra context helps the agent avoid common mistakes.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear, specific verb and resource: 'Download the file as stored for one record'. It explicitly contrasts with parsed content, metadata header, and summary, and names the sibling tool for reading content. This fully distinguishes it from pipeshub_get_record_content without needing to inspect schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit when-to-use guidance ('Use this when the user wants the file itself') and when-not-to-use ('Do not use this to read, summarize, or answer...'), and points to the correct alternative (pipeshub_get_record_content mode:"content"). It also tells the agent where to obtain recordId, leaving no ambiguity about invocation context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

pipeshub_get_record_contentA
Read-onlyIdempotent

Three operations on the org's records. Pick by what you hold:

mode:"lookup" — a URL, issue key (PA-1787), or external ID → its recordId plus the record's metadata mode:"navigate" — a question about structure: what is under X, what links to Y → browses the hierarchy mode:"content" — a recordId, and you need the document's COMPLETE text

mode:"content" (default) — the only way to see a document's complete text. Use it whenever missing part of the document could make the answer wrong: summarize, extract or list ALL of something, check whether or where a doc mentions X, review, or compare named docs. pipeshub_chat cannot do these — it never sees a whole document.

Judge by the user's INTENT, not their keywords: "what's this doc about?", "walk me through the report", "anything in here about Y?" are all full-content tasks. Get the recordId from a pipeshub_search top hit, a chat citation, or mode:"lookup".

Returns one content string: a metadata header (title, source, key fields, pre-generated summary) then the full parsed text. A record with no extractable content returns the literal No record found. Use pipeshub_download_record only for the original file bytes.

mode:"navigate" — browse the hierarchy: RecordGroup (project / space / drive / folder) → Record (epic / story / page / file) → children, with breadcrumbs, related links and record IDs.

Use it when the question depends on structure rather than wording: what is under this epic, which pages sit in this space, what is linked to this ticket, what is in this folder — and every "how many" / "all of" / "every" question. Search ranks by content; only this shows how records relate, and only this gives a count you can trust.

Omit nodeId for a flat listing of everything reachable, most recently updated first — the usual starting point. A URL, an issue key, or a pipeshub_sources id also works and resolves automatically.

Pass depth:2 or depth:3 to see several levels in ONE call — an epic's stories AND their subtasks, a space's pages AND their children — instead of one call per level. Use it whenever the question needs an overview of a hierarchy rather than a single node.

Opening a record also prints that record's own metadata — for a ticket, status, assignee, priority and dates — so a question about one record is often answered by this call alone. It returns no document text; for that, re-call with mode:"content".

Returns Path breadcrumbs, the current node's metadata, a children listing carrying record_id= or node_id= per row plus the group's total (Children 1-50 of 61), Related cross-references, and a Next: line. One page is usually every child, so only pass page:2 when that Next: line says more exist.

mode:"lookup" — turn an external reference into a recordId, the first step whenever the question names one. Returns that record's metadata (for a ticket: status, assignee, priority, dates) plus its recordId, which mode:"navigate" takes to list what is under it and mode:"content" takes to read it.

Handles Jira keys and URLs, Confluence, Drive, Slack permalinks, Linear, Notion, ServiceNow sys_id, SharePoint, Gmail/Outlook, and any connector whose records index a web URL. Resolution searches ALL connectors you can access, regardless of any source filter you used elsewhere.

A miss is a 200 with empty matches and the input echoed in not_found_identifiers — that may mean no-access, not non-existence. Use mode:"navigate" to confirm the record exists before telling the user it does not. If ambiguous is true, pick from matches rather than taking the first.

Navigate and lookup return a rendered text view whose closing Next: line names the exact follow-up call — follow it. When presenting a record, link it using the Web URL from its metadata header (when present).

ParametersJSON Schema
NameRequiredDescriptionDefault
modeNo`content` (default) reads a record's full text by `recordId`. `lookup` resolves a URL / issue key / external ID to a recordId. `navigate` browses the knowledge graph tree.content
pageNoPage number, 1-indexed.
depthNoLevels of descendants to return in one call. Above 1, the listing is a flat list of all descendants down to that level rather than only direct children, and each row carries its own `level`.
limitNoChildren per page. The minimum is 50 — smaller values are rejected rather than silently raised.
nodeIdNoThe node to open. Take it from a `record_id=` or `node_id=` shown in a previous navigate or lookup response, from a search hit's `recordId`, or from a `pipeshub_sources` id — a KB or connector id opens that source directly. Omit it entirely for the flat listing of everything reachable, newest first — the usual starting point. A URL or an issue key such as `PA-1787` also works: it is resolved to its record automatically, so no separate lookup is needed.
recordIdNoRecord identifier — usually a UUID for connector-sourced records or a 24-character ObjectId for uploaded records. Get it from a chat citation (`citations[*].recordId`) or from a `pipeshub_search` hit. Required when `mode` is `content`.
nodeTypesNoRestrict children to these node types, e.g. `["record", "folder"]`.
identifiersNoThe reference(s) to resolve: a URL, an issue key such as `PA-1787`, or a bare external system ID. Paste each exactly as you found it — tracking parameters and fragments are handled. Pass a single string, or an array of up to 10 to resolve them in one call. Required when `mode` is `lookup`.
createdAfterNoFilter children by source creation time. ISO 8601 `YYYY-MM-DD`, or a full datetime that MUST carry a timezone offset — a naive datetime is rejected rather than assumed to be UTC.
connectorNameNoOptional hint that prioritises resolution order, e.g. `JIRA`, `CONFLUENCE`, `GOOGLE_DRIVE`, `SLACK`. It cannot widen the search beyond the connectors you can already access. Useful on a retry when a lookup came back empty.
createdBeforeNoFilter children by source creation time. `YYYY-MM-DD` is inclusive of the whole day.
modifiedAfterNoFilter children by source modification time. Same formats as `createdAfter`.
modifiedBeforeNoFilter children by source modification time. Same formats as `createdBefore`.

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond annotations (readOnlyHint=true), the description discloses return formats, edge cases ('No record found', '200 with empty matches', 'ambiguous' handling), resolution behavior ('searches ALL connectors'), pagination triggers ('only pass page:2 when Next: line says more'), and rendering details. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is lengthy but every sentence adds practical value for a tool with three modes and 13 parameters. It is front-loaded with a mode summary, uses clear section headers, and avoids filler. The structure mirrors the decision flow an agent needs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex tool with no output schema, the description fully explains return values for all modes, prerequisites (like obtaining recordId), error/edge behaviors, and sibling routing. Nothing an agent needs to invoke correctly is missing, given the rich schema and annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema coverage is 100%, the description adds significant contextual meaning: explains how to obtain nodeId, when to omit it, how depth affects output, how identifiers resolve automatically, and how to interpret returns like 'Children 1-50 of 61'. These are usage patterns beyond schema field definitions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool performs three operations (lookup, navigate, content) on the org's records, with each mode named and explained. It explicitly differentiates from siblings (pipeshub_chat cannot see whole docs, pipeshub_download_record for raw bytes), making purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit when-to-use guidance per mode, including intent-based examples ('what's this doc about?' → content) and exclusions ('Use pipeshub_download_record only for the original file bytes', 'pipeshub_chat cannot do these'). Also tells when to pass depth and how to get recordId, leaving no ambiguity about selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

pipeshub_sourcesA
Read-onlyIdempotent

Discover available chat sources and AI models in one call.

Returns up to three sections:

  • sources — connectors (kind: "connector") and collections (kind: "knowledgeBase"). For pipeshub_search and pipeshub_chat, put a connector id in apps and a collection id in kb. sourcesTruncated: true means the list stopped at 1,000 sources.

  • llmModels — chat / generation models. Each item's modelKey is the value to pass on pipeshub_chat as modelKey. Pick isDefault: true unless the user asks for a specific model.

  • embeddingModels — vector embedding models (only fetched when explicitly requested via include).

Call this once at the start of a session and cache the result — sources and models change infrequently.

ParametersJSON Schema
NameRequiredDescriptionDefault
includeNoWhich sections to fetch. Default: `["sources", "llmModels"]`. Add `embeddingModels` if the user is configuring re-embedding.

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds valuable behavioral context beyond that: the 1,000-source truncation flag, conditional embedding-model fetching, and caching advice. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the one-line purpose, then organized into clear bullets for each section. Every sentence earns its place; there is no filler or repetition of annotation data.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with zero required parameters, no output schema, and comprehensive annotations, the description covers all critical information: what sections exist, their contents, defaults, truncation semantics, downstream usage, and caching recommendation. Nothing necessary for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While the schema already documents the include enum with a default, the description enriches meaning by showing how each section is consumed elsewhere (connector ids in apps, collection ids in kb, modelKey on chat, isDefault selection). This goes beyond the schema's basic parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description opens with a specific verb and resource: 'Discover available chat sources and AI models in one call.' It then enumerates the three returned sections, each tied to concrete downstream use (e.g., modelKey for pipeshub_chat), clearly distinguishing this discovery tool from its siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit usage guidance: 'Call this once at the start of a session and cache the result' and says to add embeddingModels only when configuring re-embedding. It also explains how returned ids and modelKeys flow into pipeshub_search and pipeshub_chat, so an agent knows exactly when to invoke this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev2.4.2
    • Changedpipeshub_directory5 fields changed
      • changedInput schema / properties / action / description
        Previous value: -"What to do:\n- `whoami` — return the authenticated user's identity, confirmed against the server. No other args needed.\n- `list_users` — paginated list of org users. Optional `page`, `limit`, `search` (substring match against name or email).\n- `get_user` — full profile for one user. Required `userId`. Use `whoami` to find your own id first if needed.\n- `list_groups` — paginated list of user groups (with `userCount`).\n- `list_my_teams` — teams the authenticated user belongs to, with capability flags."New value: +"What to do:\n- `whoami` — return the authenticated user's identity, confirmed against the server. No other args needed.\n- `list_users` — paginated list of org users. Optional `page`, `limit`, `search` (substring match against name or email).\n- `get_user` — full profile for one user. Required `userId`. Use `whoami` to find your own id first if needed.\n- `list_groups` — paginated list of user groups (with `userCount`). Optional `search` matches group name.\n- `list_my_teams` — teams the authenticated user belongs to, with capability flags. Optional `search` matches team name."
      • changedInput schema / properties / limit / description
        Previous value: -"Pagination — items per page. Used by list_* actions."New value: +"Items per page for list_* (1–100). Omit for the action default: 50 users, 25 groups, 100 teams."
      • changedInput schema / properties / page / description
        Previous value: -"Pagination — 1-based page number. Used by list_* actions."New value: +"1-based page for list_* actions. Omit for page 1."
      • changedInput schema / properties / search / description
        Previous value: -"Substring match against name / email. Used by list_users."New value: +"Substring match on list_users (name or email), list_groups (name), and list_my_teams (name). An empty list means no match, not an error."
      • changedInput schema / properties / userId / description
        Previous value: -"Required when `action` is `get_user`. 24-character ObjectId."New value: +"Required when `action` is `get_user`. 24-character ObjectId. Take it from `whoami` (yourself) or from a `list_users` hit."
  2. 3 tool updatesv2.4.1
    • Changedpipeshub_chat3 fields changed
      • changedInput schema / properties / filters / description
        Previous value: -"Source scoping for retrieval. Pass `apps` ids from `pipeshub_sources`. Only meaningful on the FIRST turn (when starting a new conversation)."New value: +"Which sources the answer may use. Leave out to use all sources. Only works on the FIRST turn; later turns keep the first turn's sources."
      • changedInput schema / properties / filters / properties / apps / description
        Previous value: -"Source-scoping ids from `pipeshub_sources` — connector instance and / or knowledge base ids, mixed freely. The legacy org-wide `knowledgeBase_<orgId>` id is still accepted on deployments that predate per-KB sources. Empty / omitted means no app-side restriction."New value: +"Connector ids to use. Get them from `pipeshub_sources`, where `kind` is \"connector\". Collection ids go in `kb`, not here."
      • changedInput schema / properties / filters / properties / kb / description
        Previous value: -"Legacy / unused. Leave empty."New value: +"Collection (knowledge base) ids to use. Get them from `pipeshub_sources`, where `kind` is \"knowledgeBase\"."
    • Changedpipeshub_download_record1 field changed
      • changedInput schema / properties / convertTo / description
        Previous value: -"Optional server-side format conversion target (e.g. `pdf`). When omitted, the original file bytes are returned."New value: +"The only conversion target connectors honour is `application/pdf` (the MIME type, not `pdf`). A bare `pdf` is ignored and the original file is returned with no error. Omit for the file as stored. Does not parse the document — use `pipeshub_get_record_content` `mode:\"content\"` for that."
    • Changedpipeshub_search3 fields changed
      • changedInput schema / properties / apps / description
        Previous value: -"Source-scoping ids — connector instance UUIDs and / or `knowledgeBase_<orgId>`. Get them from `pipeshub_sources`."New value: +"Connector ids to search (for example a Jira or Google Drive connection). Get them from `pipeshub_sources`, where `kind` is \"connector\". Collection ids go in `kb`, not here."
      • addedInput schema / properties / kb
        Added value: +{
        +  "description": "Collection (knowledge base) ids to search. Get them from `pipeshub_sources`, where `kind` is \"knowledgeBase\".",
        +  "items": {
        +    "type": "string"
        +  },
        +  "type": "array"
        +}
      • changedInput schema / properties / limit / description
        Previous value: -"Max number of result chunks. Default 10. Use a small value (5–10) when the goal is to resolve a filename / topic into a recordId."New value: +"Number of results. Default 10. Use 5–10 when you only need a `recordId`."
  3. 7 tool updatesv2.3.3
    • First observedpipeshub_agents
    • First observedpipeshub_chat
    • First observedpipeshub_directory
    • First observedpipeshub_download_record
    • First observedpipeshub_get_record_content
    • First observedpipeshub_search
    • First observedpipeshub_sources

TDQS

A4.7/5.0

Scored across 7 tools

Disambiguation5/5

Each tool targets a distinct operation: search locates records, chat answers grounded questions, get_record_content reads full text/navigates/looks up, download_record fetches original bytes, and agents/directory/sources handle their own domains. The descriptions explicitly cross-reference and warn against misuse, so an agent can reliably select the right tool.

Naming Consistency3/5

All tools share the pipeshub_ prefix, but the pattern after it is inconsistent: some are verb_noun (download_record, get_record_content), some are bare verbs (search, chat), and some are bare nouns (agents, directory, sources). This makes names individually readable but not predictably derivable.

Tool Count5/5

Seven tools is a well-scoped size for a knowledge retrieval and chat server. Each tool covers a major capability without unnecessary fragmentation, and no tool feels redundant.

Completeness5/5

The surface covers the full read-side workflow: discover sources, search, chat with citations, resolve external references, read full content, navigate hierarchy, download files, and look up agents and people. There are no obvious gaps or dead ends for the server's apparent purpose.

Maintenance

ActivityActive
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers