diff --git a/content/guides/sheets/features/mcp.ja-JP.mdx b/content/guides/sheets/features/mcp.ja-JP.mdx deleted file mode 100644 index 584c4ae0..00000000 --- a/content/guides/sheets/features/mcp.ja-JP.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: MCP 連携 -icon: '#pro/Sparkle' ---- - - - -## プリセットモード - -MCP 機能は現在プリセットパッケージがありません。プラグインモードでの手動インストールと設定が必要です。 - -## プラグインモード - -### インストール - -```package-install -npm install @univerjs-pro/mcp @univerjs-pro/mcp-ui @univerjs-pro/sheets-mcp -``` - -### 使い方 - -```typescript -import { UniverMCPPlugin } from '@univerjs-pro/mcp' -import { UniverMCPUIPlugin } from '@univerjs-pro/mcp-ui' -import UniverMCPUIJaJP from '@univerjs-pro/mcp-ui/locale/ja-JP' -import { UniverSheetMCPPlugin } from '@univerjs-pro/sheets-mcp' -import { LocaleType, mergeLocales, Univer } from '@univerjs/core' -import { UniverSheetPlugin } from '@univerjs/sheets' // 基本スプレッドシート機能 - -import '@univerjs-pro/mcp/facade' -import '@univerjs-pro/mcp-ui/lib/index.css' - -const univer = new Univer({ - locale: LocaleType.JA_JP, - locales: { - [LocaleType.JA_JP]: mergeLocales( - UniverMCPUIJaJP, - ), - }, -}) - -// 1. 基本スプレッドシート機能（必須） -univer.registerPlugin(UniverSheetPlugin) - -// 2. MCP コア通信プラグイン（必須） -univer.registerPlugin(UniverMCPPlugin, { - ticketServerUrl: 'https://mcp.univer.ai/api/ticket', - mcpServerUrl: 'wss://mcp.univer.ai/api/ws', -}) - -// 3. MCP ツール登録プラグイン（必須）- 30 以上の表計算ツールを自動公開 -univer.registerPlugin(UniverSheetMCPPlugin) - -// 4. （任意）デバッグ UI プラグイン -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // MCP ツールパネルを表示 -}) -``` - -## 設定 - -### セッション ID - -UniverMCPPlugin はデフォルトで sessionId: 'default' を使用しますが、以下に注意してください。 - -- sessionId ごとに同時接続できるのは 1 つだけ -- 複数ユーザー環境ではユーザー/ワークブックごとに一意の ID が必要 - -次のように指定できます。 - -```typescript -// UniverMCPPlugin の設定として渡す（推奨） -univer.registerPlugin(UniverMCPPlugin, { - sessionId: 'user-123-workbook-abc', // ← UUID などで動的に生成 - // ...その他の設定 -}) -``` - - -接続が拒否される（"session occupied"）場合は、sessionId を変更するか、以前の接続が切断されていることを確認してください。 - - -### UniverMCPPlugin の設定パラメータ - -| パラメータ | 説明 | デフォルト値 | 推奨 | -|-----------|-------------|---------------|----------------| -| sessionId | セッションの一意識別子。各 ID は 1 クライアントのみ占有可能 | 'default' | 本番環境では必ず変更して干渉を防ぐ | -| enableAuth | 認証を有効にするか（公式クラウド利用時は必須） | true | デフォルトを維持 | -| ticketServerUrl | API Key を一時チケットに交換する URL | https://mcp.univer.ai/api/ticket | 変更不要 | -| mcpServerUrl | WebSocket サービス URL | wss://mcp.univer.ai/api/ws | 変更不要 | - -### UniverMCPUIPlugin の設定オプション - -UniverMCPUIPlugin は視覚的な設定 UI を提供し、開発とデバッグを簡素化します。 - -```typescript -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // 開発者ツールと設定 UI を表示 -}) -``` - -**主な特長：** -- **API Key の視覚的設定**：UI 上で API Key を直接設定でき、ハードコード不要 -- **安全な保存**：API Key はブラウザのローカルキャッシュに安全に保存され、サーバーへは送信されない -- **開発者ツール**：デバッグ・監視ツールを提供 - -## 使用例 - -### 事前準備 - -利用開始前に MCP Server 接続の準備が必要です。 - -1. **API Key を登録**： [console.univer.ai](https://console.univer.ai) で API Key を申請 -2. **サービスモードの確認**：現在は公式クラウドのみ提供、私有デプロイは Q4 予定 - - -API Key は Univer MCP Server への接続認証に使用され、表計算機能への安全なアクセスを保証します。 - - -### Univer インスタンスの起動 - -MCP Agent を設定する前に、**MCP プラグインを登録済み**の Univer インスタンスを起動する必要があります。方法は 2 つあります。 - -**方法 1：オンライン Playground を使用** -1. [MCP Playground](https://console.univer.ai/playground) にアクセス -2. 表示された session_id を控える（または任意の値に変更） - -**方法 2：既存プロジェクトに統合** -1. [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) を参考に MCP を統合 -2. プロジェクト側の sessionId と MCP Agent 側の設定を一致させる - - -重要：Univer インスタンスの sessionId と MCP Agent 設定の univer_session_id が一致しないとツールが有効になりません。 - - -### MCP Agent（LLM クライアント）の設定 - -MCP 対応 Agent にサービス URL を設定します。 - -```json -{ - "mcpServers": { - "univer": { - "url": "https://mcp.univer.ai/mcp/?univer_session_id=user-123-workbook-abc", - "type": "http", - "headers": { - "Authorization": "Bearer YOUR_API_KEY" - } - } - } -} -``` - -設定のポイント： -- `YOUR_API_KEY`： https://console.univer.ai で取得 -- `univer_session_id`：**Univer 側の sessionId と完全一致が必須** - - -設定が完了すると、Agent が表計算ツールを自動的に発見して呼び出します。例： -"B2 に 100 をセット" → `set_range_data({ range: 'B2', value: 100 })` - - -### 接続確認 - -設定後、次の方法で接続を確認できます。 - -1. **ツール一覧の確認**：MCP クライアントで 30 以上の Univer ツールが表示される -2. **簡単な操作のテスト**：「A1 に Hello を書いて」と依頼 -3. **Univer インスタンスの確認**：リアルタイムに反映されることを確認 - -## トラブルシューティング - -### ツールが有効にならない／一覧が空 - -最も多い問題です。次の順で確認してください。 - -1. **API Key が有効か**： [console.univer.ai](https://console.univer.ai) で状態確認 -2. **Univer インスタンスが起動しているか**：Playground / ローカルを確認 -3. **session_id が一致しているか**： - ``` - MCP 側 univer_session_id = Univer 側 sessionId - ``` -4. **ネットワーク接続**：mcp.univer.ai に到達できるか - -### Agent 側（MCP クライアント） - -基本接続が問題ない場合でも、以下を確認してください。 - -- ツール呼び出しが **エラーメッセージを返しているか** → エラー内容を確認 -- 実行後に Univer が **反応しないか** → Univer インスタンス側を確認 - -### Univer インスタンス側 - -以下を確認してください。 - -- **3 つの MCP プラグイン**がすべて登録されているか -- **基本スプレッドシートプラグイン**（UniverSheetPlugin）が有効か -- 権限設定は正しいか、MCP Server に接続できているか -- ブラウザコンソールにエラーが出ていないか -- univer_session_id は Agent 側と完全一致しているか - -## セキュリティとベストプラクティス - -- 本番環境で `default` を sessionId に使用しない -- API Key はサーバー側のみで使用し、ブラウザへ渡さない。ブラウザ側の認証はサーバーで一時クレデンシャルを発行して API Key の露出を防ぐ - -## 次のステップ - -- MCP Server をセルフホストしたい場合： [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) の進捗を確認 -- クイックスタート： [MCP Playground](https://console.univer.ai/playground) を試す -- 完全ガイド： [MCP ドキュメントガイド](https://console.univer.ai/mcpguide) -- 問題報告時は sessionId、Agent 種別、エラーログ、Univer バージョンを添付 - -## サポートされる MCP ツール - -Univer MCP は 30 以上のスプレッドシート操作ツールを自動提供します。主なカテゴリは次の通りです。 - -- **データ操作**：セルデータの設定/取得、検索、オートフィルなど -- **ワークシート管理**：シートの作成/削除/名前変更など -- **構造操作**：行/列の挿入・削除、セル結合、サイズ調整など -- **書式とスタイル**：セルスタイル、条件付き書式など -- **データ検証**：データ検証ルールの追加・管理など - -詳細なツール一覧は [Start Kit ドキュメント](https://github.com/dream-num/univer-mcp-start-kit#currently-supported-mcp-tools) を参照してください。 - -## よくある質問（FAQ） - -### Q1: ページを更新すると "session occupied" と表示されるのはなぜ？ - -**A:** sessionId のデフォルトは 'default' で、各 sessionId は同時に 1 クライアントしか接続できません。 - -**解決策：** ユーザーまたはインスタンスごとに一意 ID を生成します。 - -``` -sessionId: `user-${userId}` -// 一時的な回避策 -sessionId: `temp-${Date.now()}-${Math.random().toString(36).slice(2)}` -``` - -### Q2: Agent ではツール一覧が見えるが、実行しても反応しない。コンソールで UniverAPI not available と出る？ - -**A:** 現在の Univer MCP は window.univerAPI に依存しています。 - -統合手順の詳細は [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) の完全な例を参照してください。 - -### Q3: なぜ UniverSheetPlugin などの登録が必要？MCP プラグインだけではダメ？ - -**A:** UniverSheetMCPPlugin は MCP ツールと Univer API を紐付けるだけで、表計算の実処理は持ちません。 -getRange() や setValue() などの機能は UniverSheetPlugin が提供します。 - -**解決策：** 先に基本プラグインを登録しないとツール実行に失敗します。 - -### Q4: MCP Server に LLM の指示が届いているか確認・デバッグするには？ - -**A:** -- **バックエンド（クラウド）**： https://console.univer.ai のログで MCP 呼び出しを確認 -- **ネットワーク**：ブラウザ DevTools の Network → WS で WebSocket メッセージを確認 - -### Q5: API Key はどこで取得？Claude Pro ユーザーはどう使う？ - -**A:** -- API Key は https://console.univer.ai で申請 -- すべての MCP クライアント（Claude/Cursor/OpenAI など）は HTTP ヘッダーで渡します。 - -```http -Authorization: Bearer YOUR_API_KEY -``` - -- Claude CLI を使っているかどうかは関係なく、Pro ユーザーも同様に利用できます。 - -### Q6: MCP ツールは自動提供？set_range_data のハンドラは自分で書く必要がある？ - -**A:** いいえ。 -UniverSheetMCPPlugin を正しく登録すれば、set_range_data や insert_rows など 30 以上の組み込みツールが自動登録されます。MCP Server が Univer 内部 API を直接呼び出すため、ハンドラを自作する必要はありません。 diff --git a/content/guides/sheets/features/mcp.mdx b/content/guides/sheets/features/mcp.mdx deleted file mode 100644 index 1dd24a13..00000000 --- a/content/guides/sheets/features/mcp.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: MCP Integration -icon: '#pro/Sparkle' ---- - - - -## Preset Mode - -MCP functionality currently has no preset packages available. Manual installation and configuration through plugin mode is required. - -## Plugin Mode - -### Installation - -```package-install -npm install @univerjs-pro/mcp @univerjs-pro/mcp-ui @univerjs-pro/sheets-mcp -``` - -### Usage - -```typescript -import { UniverMCPPlugin } from '@univerjs-pro/mcp' -import { UniverMCPUIPlugin } from '@univerjs-pro/mcp-ui' -import UniverMCPUIEnUS from '@univerjs-pro/mcp-ui/locale/en-US' -import { UniverSheetMCPPlugin } from '@univerjs-pro/sheets-mcp' -import { LocaleType, mergeLocales, Univer } from '@univerjs/core' -import { UniverSheetPlugin } from '@univerjs/sheets' // Basic spreadsheet functionality - -import '@univerjs-pro/mcp/facade' -import '@univerjs-pro/mcp-ui/lib/index.css' - -const univer = new Univer({ - locale: LocaleType.EN_US, - locales: { - [LocaleType.EN_US]: mergeLocales( - UniverMCPUIEnUS, - ), - }, -}) - -// 1. Basic spreadsheet functionality (required) -univer.registerPlugin(UniverSheetPlugin) - -// 2. MCP core communication plugin (required) -univer.registerPlugin(UniverMCPPlugin, { - ticketServerUrl: 'https://mcp.univer.ai/api/ticket', - mcpServerUrl: 'wss://mcp.univer.ai/api/ws', -}) - -// 3. MCP tool registration plugin (required) - automatically exposes 30+ spreadsheet operation tools -univer.registerPlugin(UniverSheetMCPPlugin) - -// 4. (Optional) Debug UI plugin -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // Show MCP tool panel for debugging -}) -``` - -## Configuration - -### Session ID - -UniverMCPPlugin uses sessionId: 'default' by default, but: - -- Each sessionId only allows one active connection -- In multi-user scenarios, a unique ID must be assigned for each user/workbook - -You can specify it in the following way: - -```typescript -// Pass in UniverMCPPlugin configuration (recommended) -univer.registerPlugin(UniverMCPPlugin, { - sessionId: 'user-123-workbook-abc', // ← Generate dynamically, such as UUID - // ...other configurations -}) -``` - - -If connection is rejected ("session occupied"), please change sessionId or ensure previous connection is disconnected. - - -### UniverMCPPlugin Configuration Parameters - -| Parameter | Description | Default Value | Recommendation | -|-----------|-------------|---------------|----------------| -| sessionId | Unique session identifier. Each ID can only be occupied by one client | 'default' | Must customize for production environment to avoid user interference | -| enableAuth | Whether to enable authentication (required for official cloud service) | true | Keep default | -| ticketServerUrl | URL for exchanging API Key for temporary ticket | https://mcp.univer.ai/api/ticket | No modification needed | -| mcpServerUrl | WebSocket service URL | wss://mcp.univer.ai/api/ws | No modification needed | - -### UniverMCPUIPlugin Configuration Options - -UniverMCPUIPlugin provides a visual configuration interface to simplify development and debugging: - -```typescript -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // Show developer tools and configuration interface -}) -``` - -**Key Features:** -- **Visual API Key Configuration**: Supports direct API Key configuration in the interface without hardcoding -- **Secure Storage**: API Key is securely stored in browser local cache and not distributed to server -- **Developer Tools**: Provides debugging and monitoring tools for development debugging - -## Usage Examples - -### Preparation - -Before starting, you need to prepare MCP Server connection: - -1. **Register API Key**: Visit [console.univer.ai](https://console.univer.ai) to apply for API Key -2. **Choose Service Mode**: Currently provides official cloud service, private deployment service expected in Q4 - - -API Key is used to authenticate your connection with Univer MCP Server, ensuring secure access to spreadsheet operation functions. - - -### Start Univer Instance - -Before configuring MCP Agent, you must first start a Univer instance with **MCP plugins registered**. There are two ways: - -**Method 1: Use Online Playground** -1. Visit [MCP Playground](https://console.univer.ai/playground) -2. Remember the displayed session_id (or customize one) - -**Method 2: Integrate into Existing Project** -1. Refer to [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) to integrate MCP functionality into your project -2. Ensure the sessionId configuration in your project matches the MCP Agent configuration - - -Critical: The sessionId of Univer instance must strictly match the univer_session_id in MCP Agent configuration, otherwise tools cannot be enabled. - - -### Configure MCP Agent (LLM Client) - -Configure service address in MCP-supported Agent: - -```json -{ - "mcpServers": { - "univer": { - "url": "https://mcp.univer.ai/mcp/?univer_session_id=user-123-workbook-abc", - "type": "http", - "headers": { - "Authorization": "Bearer YOUR_API_KEY" - } - } - } -} -``` - -Configuration explanation: -- `YOUR_API_KEY`: Obtain from https://console.univer.ai -- `univer_session_id`: **Must strictly match the sessionId of Univer instance**, this is the key to connection - - -After successful configuration, Agent will automatically discover and call spreadsheet tools, for example: -"Set cell B2 to 100" → calls `set_range_data({ range: 'B2', value: 100 })` - - -### Verify Connection - -After configuration, you can verify the connection in the following ways: - -1. **Check Tool List**: You should be able to see 30+ Univer tools in the MCP client -2. **Test Simple Operations**: Try asking "write Hello in cell A1" -3. **Observe Univer Instance**: You should see real-time changes in the instance - -## Troubleshooting - -### Tools Not Enabled or List Empty - -This is the most common issue. Please check in the following order: - -1. **Is API Key valid**: Confirm API Key status at [console.univer.ai](https://console.univer.ai) -2. **Is Univer instance running**: Confirm Playground or local instance is running -3. **Are session_ids consistent**: - ``` - univer_session_id in MCP configuration = sessionId in Univer instance - ``` -4. **Network connection**: Check if you can access mcp.univer.ai - -### Agent Side (MCP Client) - -If basic connection is normal but still having issues, check: - -- Does tool call **return error messages**? → Check specific error content -- Univer **no response** after tool execution? → Go to Univer instance side troubleshooting - -### Univer Instance Side - -Check the following issues: - -- Are **all three** MCP plugins registered? -- Is **basic spreadsheet plugin** (UniverSheetPlugin) enabled? -- Is permission configuration correct, has Univer instance successfully connected to MCP Server? -- Are there errors in browser console? -- Does univer_session_id strictly match the Agent side? - -## Security and Best Practices - -- Do not use `default` as sessionId in production environment -- API Key should only be used on server side, not passed to browser side. Browser side authentication needs to obtain temporary credentials through server side to ensure API Key is not exposed - -## Next Steps - -- Want to self-host MCP Server? Follow the progress of [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) -- Quick start: Use [MCP Playground](https://console.univer.ai/playground) for online experience -- Complete guide: Check [MCP Documentation Guide](https://console.univer.ai/mcpguide) -- Having issues? Provide: sessionId, Agent type, error logs, Univer version - -## Supported MCP Tools - -Univer MCP automatically provides 30+ spreadsheet operation tools, mainly including: - -- **Data Operations**: Set and read cell data, search content, auto-fill, etc. -- **Worksheet Management**: Create, delete, rename worksheets, etc. -- **Structure Operations**: Insert/delete rows and columns, merge cells, adjust dimensions, etc. -- **Format & Styling**: Apply cell styles, conditional formatting, etc. -- **Data Validation**: Add and manage data validation rules, etc. - -For detailed tool list, please refer to [Start Kit Documentation](https://github.com/dream-num/univer-mcp-start-kit#currently-supported-mcp-tools). - -## Frequently Asked Questions (FAQ) - -### Q1: Why does it prompt "session occupied" after refreshing the page? - -**A:** sessionId defaults to 'default', and each sessionId can only be connected by one client at a time. - -**Solution:** Generate unique ID for each user or instance, for example: - -``` -sessionId: `user-${userId}` -// Or temporary solution -sessionId: `temp-${Date.now()}-${Math.random().toString(36).slice(2)}` -``` - -### Q2: Agent can see tool list, but Univer doesn't respond when executing, console shows UniverAPI not available error? - -**A:** Current version of Univer MCP depends on window.univerAPI to work. - -For detailed integration steps, please refer to the complete example in [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit). - -### Q3: Why must UniverSheetPlugin and other plugins be registered? Can't I just register MCP plugins? - -**A:** UniverSheetMCPPlugin itself doesn't contain spreadsheet operation capabilities, it only maps MCP tools to Univer API. -The actual getRange(), setValue() and other functions are provided by UniverSheetPlugin. - -**Solution:** Basic plugins must be registered first, otherwise tool execution will fail. - -### Q4: How do I know if MCP Server received LLM instructions? How to debug? - -**A:** -- **Backend (Cloud Service):** https://console.univer.ai logs page can access all MCP call logs -- **Network:** Check WebSocket messages in browser DevTools Network → WS - -### Q5: Where to get API Key? How do Claude Pro users use it? - -**A:** -- Apply for API Key at https://console.univer.ai -- All MCP clients (including Claude, Cursor, OpenAI) pass through HTTP Header: - -```http -Authorization: Bearer YOUR_API_KEY -``` - -- It has nothing to do with whether you use Claude CLI, Pro users can use it the same way. - -### Q6: Are MCP tools automatically provided? Do I need to write handlers for set_range_data myself? - -**A:** No need. -As long as UniverSheetMCPPlugin is correctly registered, it will automatically register 30+ built-in spreadsheet tools (such as set_range_data, insert_rows, etc.), and MCP Server will directly call Univer internal API for execution. You don't need to implement handlers manually. diff --git a/content/guides/sheets/features/mcp.zh-CN.mdx b/content/guides/sheets/features/mcp.zh-CN.mdx deleted file mode 100644 index 396bf228..00000000 --- a/content/guides/sheets/features/mcp.zh-CN.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: MCP 集成 -icon: '#pro/Sparkle' ---- - - - -## 预设模式 - -MCP 功能目前暂无预设包，需要通过插件模式手动安装配置。 - -## 插件模式 - -### 安装 - -```package-install -npm install @univerjs-pro/mcp @univerjs-pro/mcp-ui @univerjs-pro/sheets-mcp -``` - -### 使用 - -```typescript -import { UniverMCPPlugin } from '@univerjs-pro/mcp' -import { UniverMCPUIPlugin } from '@univerjs-pro/mcp-ui' -import UniverMCPUIZhCN from '@univerjs-pro/mcp-ui/locale/zh-CN' -import { UniverSheetMCPPlugin } from '@univerjs-pro/sheets-mcp' -import { LocaleType, mergeLocales, Univer } from '@univerjs/core' -import { UniverSheetPlugin } from '@univerjs/sheets' // 基础表格能力 - -import '@univerjs-pro/mcp/facade' -import '@univerjs-pro/mcp-ui/lib/index.css' - -const univer = new Univer({ - locale: LocaleType.ZH_CN, - locales: { - [LocaleType.ZH_CN]: mergeLocales( - UniverMCPUIZhCN, - ), - }, -}) - -// 1. 基础表格功能（必需） -univer.registerPlugin(UniverSheetPlugin) - -// 2. MCP 核心通信插件（必需） -univer.registerPlugin(UniverMCPPlugin, { - ticketServerUrl: 'https://mcp.univer.ai/api/ticket', - mcpServerUrl: 'wss://mcp.univer.ai/api/ws', -}) - -// 3. MCP 工具注册插件（必需）——自动暴露 30+ 表格操作工具 -univer.registerPlugin(UniverSheetMCPPlugin) - -// 4. （可选）调试 UI 插件 -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // 显示 MCP 工具面板，便于调试 -}) -``` - -## 配置 - -### 会话标识（Session ID） - -UniverMCPPlugin 默认使用 sessionId: 'default'，但： - -- 每个 sessionId 仅允许一个活跃连接 -- 多用户场景下，必须为每个用户/工作簿分配唯一 ID - -可通过以下方式指定： - -```typescript -// 在 UniverMCPPlugin 配置中传入（推荐） -univer.registerPlugin(UniverMCPPlugin, { - sessionId: 'user-123-workbook-abc', // ← 动态生成，如 UUID - // ...其他配置 -}) -``` - - -若连接被拒绝（"session occupied"），请更换 sessionId 或确保前一连接已断开。 - - -### UniverMCPPlugin 配置参数 - -| 参数名 | 说明 | 默认值 | 建议 | -|--------|------|--------|------| -| sessionId | 会话唯一标识。每个 ID 只能被一个客户端占用 | 'default' | 生产环境务必自定义，避免用户互相干扰 | -| enableAuth | 是否启用认证（连接官方云服务必需） | true | 保持默认 | -| ticketServerUrl | API Key 换取临时 ticket 的地址 | https://mcp.univer.ai/api/ticket | 无需修改 | -| mcpServerUrl | WebSocket 服务地址 | wss://mcp.univer.ai/api/ws | 无需修改 | - -### UniverMCPUIPlugin 配置选项 - -UniverMCPUIPlugin 提供可视化配置界面，简化开发和调试： - -```typescript -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // 显示开发者工具和配置界面 -}) -``` - -**主要特性：** -- **可视化 API Key 配置**：支持在界面中直接配置 API Key，无需硬编码 -- **安全存储**：API Key 安全存储在浏览器本地缓存，不会被分发到服务端 -- **开发者工具**：提供调试和监控工具，便于开发调试 - -## 使用示例 - -### 准备工作 - -在开始使用前，需要准备 MCP Server 连接： - -1. **注册 API Key**：访问 [console.univer.ai](https://console.univer.ai) 申请 API Key -2. **选择服务模式**：当前提供官方云服务，私有部署服务预计在 Q4 提供 - - -API Key 用于认证你与 Univer MCP Server 的连接，确保安全访问表格操作功能。 - - -### 启动 Univer 实例 - -在配置 MCP Agent 之前，必须先启动一个**已注册 MCP 插件**的 Univer 实例。有两种方式： - -**方式一：使用在线 Playground** -1. 访问 [MCP Playground](https://console.univer.ai/playground) -2. 记住显示的 session_id（或自定义一个） - -**方式二：集成到现有项目** -1. 参考 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 将 MCP 功能集成到你的项目中 -2. 确保项目中的 sessionId 配置与 MCP Agent 配置保持一致 - - -关键：Univer 实例的 sessionId 必须与 MCP Agent 配置中的 univer_session_id 严格一致，否则工具无法启用。 - - -### 配置 MCP Agent（LLM 客户端） - -在支持 MCP 的 Agent 中配置服务地址： - -```json -{ - "mcpServers": { - "univer": { - "url": "https://mcp.univer.ai/mcp/?univer_session_id=user-123-workbook-abc", - "type": "http", - "headers": { - "Authorization": "Bearer YOUR_API_KEY" - } - } - } -} -``` - -配置说明： -- `YOUR_API_KEY`：从 https://console.univer.ai 获取 -- `univer_session_id`：**必须与 Univer 实例的 sessionId 严格一致**，这是连接的关键 - - -配置成功后，Agent 将自动发现并调用表格工具，例如： -"将 B2 单元格设为 100" → 调用 `set_range_data({ range: 'B2', value: 100 })` - - -### 验证连接 - -配置完成后，可以通过以下方式验证连接： - -1. **检查工具列表**：在 MCP 客户端中应该能看到 30+ Univer 工具 -2. **测试简单操作**：尝试询问 "在 A1 单元格写入 Hello" -3. **观察 Univer 实例**：实例中应该能看到实时变化 - -## 故障排查 - -### 工具未启用或列表为空 - -这是最常见的问题，请按以下顺序检查： - -1. **API Key 是否有效**：在 [console.univer.ai](https://console.univer.ai) 确认 API Key 状态 -2. **Univer 实例是否运行**：确认 Playground 或本地实例正在运行 -3. **session_id 是否一致**： - ``` - MCP 配置中的 univer_session_id = Univer 实例中的 sessionId - ``` -4. **网络连接**：检查是否能访问 mcp.univer.ai - -### Agent 侧（MCP 客户端） - -如果基础连接正常但仍有问题，检查： - -- 调用工具时是否**返回错误信息**？→ 查看具体错误内容 -- 工具执行后 Univer **无反应**？→ 进入 Univer 实例侧排查 - -### Univer 实例侧 - -检查以下问题： - -- 是否注册了**全部三个** MCP 插件？ -- 是否启用了**基础表格插件**（UniverSheetPlugin）？ -- 权限配置是否正确，Univer 实例是否成功连接到 MCP Server？ -- 浏览器控制台是否有错误？ -- univer_session_id 是否与 Agent 侧严格一致？ - -## 安全与最佳实践 - -- 不要使用 `default` 作为生产环境的 sessionId -- API Key 仅可在服务端使用，不传给浏览器端，浏览器端认证需通过服务端获取临时凭证，保证 API Key 不暴露 - -## 下一步 - -- 想自建 MCP Server？关注 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 开源进展 -- 快速开始：使用 [MCP Playground](https://console.univer.ai/playground) 在线体验 -- 完整指南：查看 [MCP 文档指南](https://console.univer.ai/mcpguide) -- 遇到问题？提供：sessionId、Agent 类型、错误日志、Univer 版本 - -## 支持的MCP工具 - -Univer MCP 自动提供30+表格操作工具，主要包括： - -- **数据操作**：设置和读取单元格数据、搜索内容、自动填充等 -- **工作表管理**：创建、删除、重命名工作表等 -- **结构操作**：插入删除行列、合并单元格、调整尺寸等 -- **格式样式**：应用单元格样式、条件格式等 -- **数据验证**：添加和管理数据验证规则等 - -详细工具列表请参考 [Start Kit 文档](https://github.com/dream-num/univer-mcp-start-kit#currently-supported-mcp-tools)。 - -## 常见问题（FAQ） - -### Q1：为什么刷新页面后提示"会话已被占用"（session occupied）？ - -**A：** sessionId 默认为 'default'，而每个 sessionId 同一时间只能被一个客户端连接。 - -**解决方案：** 为每个用户或实例生成唯一 ID，例如： - -``` -sessionId: `user-${userId}` -// 或临时方案 -sessionId: `temp-${Date.now()}-${Math.random().toString(36).slice(2)}` -``` - -### Q2：Agent 能看到工具列表，但执行时 Univer 没反应，控制台报错 UniverAPI not available？ - -**A：** 当前版本的 Univer MCP 依赖 window.univerAPI 工作。 - -详细的集成步骤可以参考 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 的完整示例。 - -### Q3：为什么必须注册 UniverSheetPlugin 等其他插件？只注册 MCP 插件不行吗？ - -**A：** UniverSheetMCPPlugin 本身不包含表格操作能力，它只是将 MCP 工具映射到 Univer API。 -实际的 getRange()、setValue() 等功能由 UniverSheetPlugin 提供。 - -**解决方案：** 必须先注册基础插件，否则工具执行会失败。 - -### Q4：如何知道 MCP Server 收到了 LLM 的指令？如何调试？ - -**A：** -- **后端（云服务）：** https://console.univer.ai 日志页面可以访问所有的 MCP 调用日志 -- **网络：** 在浏览器 DevTools 的 Network → WS 中查看 WebSocket 消息 - -### Q5：API Key 从哪里获取？Claude Pro 用户怎么用？ - -**A：** -- API Key 在 https://console.univer.ai 申请 -- 所有 MCP 客户端（包括 Claude、Cursor、OpenAI）均通过 HTTP Header 传递： - -``` -Authorization: Bearer YOUR_API_KEY -``` - -- 与是否使用 Claude CLI 无关，Pro 用户同样适用。 - -### Q6：MCP 工具是自动提供的吗？需要我自己写 set_range_data 的 handler 吗？ - -**A：** 不需要。 -只要正确注册了 UniverSheetMCPPlugin，它会自动注册 30+ 内置表格工具（如 set_range_data, insert_rows 等），MCP Server 会直接调用 Univer 内部 API 执行。你无需手动实现 handler。 diff --git a/content/guides/sheets/features/mcp.zh-TW.mdx b/content/guides/sheets/features/mcp.zh-TW.mdx deleted file mode 100644 index 8df12a14..00000000 --- a/content/guides/sheets/features/mcp.zh-TW.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: MCP 整合 -icon: '#pro/Sparkle' ---- - - - -## 預設模式 - -MCP 功能目前暫無預設包，需要透過外掛模式手動安裝配置。 - -## 外掛模式 - -### 安裝 - -```package-install -npm install @univerjs-pro/mcp @univerjs-pro/mcp-ui @univerjs-pro/sheets-mcp -``` - -### 使用 - -```typescript -import { UniverMCPPlugin } from '@univerjs-pro/mcp' -import { UniverMCPUIPlugin } from '@univerjs-pro/mcp-ui' -import UniverMCPUIZhTW from '@univerjs-pro/mcp-ui/locale/zh-TW' -import { UniverSheetMCPPlugin } from '@univerjs-pro/sheets-mcp' -import { LocaleType, mergeLocales, Univer } from '@univerjs/core' -import { UniverSheetPlugin } from '@univerjs/sheets' // 基礎表格能力 - -import '@univerjs-pro/mcp/facade' -import '@univerjs-pro/mcp-ui/lib/index.css' - -const univer = new Univer({ - locale: LocaleType.ZH_TW, - locales: { - [LocaleType.ZH_TW]: mergeLocales( - UniverMCPUIZhTW, - ), - }, -}) - -// 1. 基礎表格功能（必需） -univer.registerPlugin(UniverSheetPlugin) - -// 2. MCP 核心通訊外掛（必需） -univer.registerPlugin(UniverMCPPlugin, { - ticketServerUrl: 'https://mcp.univer.ai/api/ticket', - mcpServerUrl: 'wss://mcp.univer.ai/api/ws', -}) - -// 3. MCP 工具註冊外掛（必需）——自動暴露 30+ 表格操作工具 -univer.registerPlugin(UniverSheetMCPPlugin) - -// 4. （可選）除錯 UI 外掛 -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // 顯示 MCP 工具面板，便於除錯 -}) -``` - -## 配置 - -### 會話標識（Session ID） - -UniverMCPPlugin 預設使用 sessionId: 'default'，但： - -- 每個 sessionId 僅允許一個活躍連線 -- 多使用者場景下，必須為每個使用者/工作簿分配唯一 ID - -可透過以下方式指定： - -```typescript -// 在 UniverMCPPlugin 配置中傳入（推薦） -univer.registerPlugin(UniverMCPPlugin, { - sessionId: 'user-123-workbook-abc', // ← 動態生成，如 UUID - // ...其他配置 -}) -``` - - -若連線被拒絕（"session occupied"），請更換 sessionId 或確保前一連線已斷開。 - - -### UniverMCPPlugin 配置參數 - -| 參數名 | 說明 | 預設值 | 建議 | -|--------|------|--------|------| -| sessionId | 會話唯一標識。每個 ID 只能被一個客戶端佔用 | 'default' | 生產環境務必自訂，避免使用者互相干擾 | -| enableAuth | 是否啟用認證（連線官方雲服務必需） | true | 保持預設 | -| ticketServerUrl | API Key 換取臨時 ticket 的地址 | https://mcp.univer.ai/api/ticket | 無需修改 | -| mcpServerUrl | WebSocket 服務地址 | wss://mcp.univer.ai/api/ws | 無需修改 | - -### UniverMCPUIPlugin 配置選項 - -UniverMCPUIPlugin 提供視覺化配置介面，簡化開發和除錯： - -```typescript -univer.registerPlugin(UniverMCPUIPlugin, { - showDeveloperTools: true, // 顯示開發者工具和配置介面 -}) -``` - -**主要特性：** -- **視覺化 API Key 配置**：支援在介面中直接配置 API Key，無需硬編碼 -- **安全儲存**：API Key 安全儲存在瀏覽器本地快取，不會被分發到服務端 -- **開發者工具**：提供除錯和監控工具，便於開發除錯 - -## 使用示例 - -### 準備工作 - -在開始使用前，需要準備 MCP Server 連線： - -1. **註冊 API Key**：訪問 [console.univer.ai](https://console.univer.ai) 申請 API Key -2. **選擇服務模式**：當前提供官方雲服務，私有部署服務預計在 Q4 提供 - - -API Key 用於認證你與 Univer MCP Server 的連線，確保安全訪問表格操作功能。 - - -### 啟動 Univer 例項 - -在配置 MCP Agent 之前，必須先啟動一個**已註冊 MCP 外掛**的 Univer 例項。有兩種方式： - -**方式一：使用線上 Playground** -1. 訪問 [MCP Playground](https://console.univer.ai/playground) -2. 記住顯示的 session_id（或自訂一個） - -**方式二：整合到現有專案** -1. 參考 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 將 MCP 功能整合到你的專案中 -2. 確保專案中的 sessionId 配置與 MCP Agent 配置保持一致 - - -關鍵：Univer 例項的 sessionId 必須與 MCP Agent 配置中的 univer_session_id 嚴格一致，否則工具無法啟用。 - - -### 配置 MCP Agent（LLM 客戶端） - -在支援 MCP 的 Agent 中配置服務地址： - -```json -{ - "mcpServers": { - "univer": { - "url": "https://mcp.univer.ai/mcp/?univer_session_id=user-123-workbook-abc", - "type": "http", - "headers": { - "Authorization": "Bearer YOUR_API_KEY" - } - } - } -} -``` - -配置說明： -- `YOUR_API_KEY`：從 https://console.univer.ai 獲取 -- `univer_session_id`：**必須與 Univer 例項的 sessionId 嚴格一致**，這是連線的關鍵 - - -配置成功後，Agent 將自動發現並呼叫表格工具，例如： -"將 B2 單元格設為 100" → 呼叫 `set_range_data({ range: 'B2', value: 100 })` - - -### 驗證連線 - -配置完成後，可以透過以下方式驗證連線： - -1. **檢查工具列表**：在 MCP 客戶端中應該能看到 30+ Univer 工具 -2. **測試簡單操作**：嘗試詢問 "在 A1 單元格寫入 Hello" -3. **觀察 Univer 例項**：例項中應該能看到實時變化 - -## 故障排查 - -### 工具未啟用或列表為空 - -這是最常見的問題，請按以下順序檢查： - -1. **API Key 是否有效**：在 [console.univer.ai](https://console.univer.ai) 確認 API Key 狀態 -2. **Univer 例項是否執行**：確認 Playground 或本地例項正在執行 -3. **session_id 是否一致**： - ``` - MCP 配置中的 univer_session_id = Univer 例項中的 sessionId - ``` -4. **網路連線**：檢查是否能訪問 mcp.univer.ai - -### Agent 側（MCP 客戶端） - -如果基礎連線正常但仍有問題，檢查： - -- 呼叫工具時是否**返回錯誤資訊**？→ 檢視具體錯誤內容 -- 工具執行後 Univer **無反應**？→ 進入 Univer 例項側排查 - -### Univer 例項側 - -檢查以下問題： - -- 是否註冊了**全部三個** MCP 外掛？ -- 是否啟用了**基礎表格外掛**（UniverSheetPlugin）？ -- 權限配置是否正確，Univer 例項是否成功連線到 MCP Server？ -- 瀏覽器控制檯是否有錯誤？ -- univer_session_id 是否與 Agent 側嚴格一致？ - -## 安全與最佳實踐 - -- 不要使用 `default` 作為生產環境的 sessionId -- API Key 僅可在服務端使用，不傳給瀏覽器端，瀏覽器端認證需透過服務端獲取臨時憑證，保證 API Key 不暴露 - -## 下一步 - -- 想自建 MCP Server？關注 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 開源進展 -- 快速開始：使用 [MCP Playground](https://console.univer.ai/playground) 線上體驗 -- 完整指南：檢視 [MCP 文件指南](https://console.univer.ai/mcpguide) -- 遇到問題？提供：sessionId、Agent 型別、錯誤日誌、Univer 版本 - -## 支援的MCP工具 - -Univer MCP 自動提供30+表格操作工具，主要包括： - -- **資料操作**：設定和讀取單元格資料、搜尋內容、自動填充等 -- **工作表管理**：建立、刪除、重新命名工作表等 -- **結構操作**：插入刪除行列、合併單元格、調整尺寸等 -- **格式樣式**：應用單元格樣式、條件格式等 -- **資料驗證**：新增和管理資料驗證規則等 - -詳細工具列表請參考 [Start Kit 文件](https://github.com/dream-num/univer-mcp-start-kit#currently-supported-mcp-tools)。 - -## 常見問題（FAQ） - -### Q1：為什麼重新整理頁面後提示"會話已被佔用"（session occupied）？ - -**A：** sessionId 預設為 'default'，而每個 sessionId 同一時間只能被一個客戶端連線。 - -**解決方案：** 為每個使用者或例項生成唯一 ID，例如： - -``` -sessionId: `user-${userId}` -// 或臨時方案 -sessionId: `temp-${Date.now()}-${Math.random().toString(36).slice(2)}` -``` - -### Q2：Agent 能看到工具列表，但執行時 Univer 沒反應，控制檯報錯 UniverAPI not available？ - -**A：** 當前版本的 Univer MCP 依賴 window.univerAPI 工作。 - -詳細的整合步驟可以參考 [univer-mcp-start-kit](https://github.com/dream-num/univer-mcp-start-kit) 的完整示例。 - -### Q3：為什麼必須註冊 UniverSheetPlugin 等其他外掛？只註冊 MCP 外掛不行嗎？ - -**A：** UniverSheetMCPPlugin 本身不包含表格操作能力，它只是將 MCP 工具對映到 Univer API。 -實際的 getRange()、setValue() 等功能由 UniverSheetPlugin 提供。 - -**解決方案：** 必須先註冊基礎外掛，否則工具執行會失敗。 - -### Q4：如何知道 MCP Server 收到了 LLM 的指令？如何除錯？ - -**A：** -- **後端（雲服務）：** https://console.univer.ai 日誌頁面可以訪問所有的 MCP 呼叫日誌 -- **網路：** 在瀏覽器 DevTools 的 Network → WS 中檢視 WebSocket 訊息 - -### Q5：API Key 從哪裡獲取？Claude Pro 使用者怎麼用？ - -**A：** -- API Key 在 https://console.univer.ai 申請 -- 所有 MCP 客戶端（包括 Claude、Cursor、OpenAI）均透過 HTTP Header 傳遞： - -``` -Authorization: Bearer YOUR_API_KEY -``` - -- 與是否使用 Claude CLI 無關，Pro 使用者同樣適用。 - -### Q6：MCP 工具是自動提供的嗎？需要我自己寫 set_range_data 的 handler 嗎？ - -**A：** 不需要。 -只要正確註冊了 UniverSheetMCPPlugin，它會自動註冊 30+ 內建表格工具（如 set_range_data, insert_rows 等），MCP Server 會直接呼叫 Univer 內部 API 執行。你無需手動實現 handler。 diff --git a/content/guides/sheets/getting-started/mcp.ja-JP.mdx b/content/guides/sheets/getting-started/mcp.ja-JP.mdx deleted file mode 100644 index 7fa0a5f5..00000000 --- a/content/guides/sheets/getting-started/mcp.ja-JP.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MCP -icon: '#pro/Wand' ---- - -MCP（Model Context Protocol）連携により、大規模言語モデルが標準プロトコルで安全に Univer のスプレッドシートを操作できます。Cursor や Claude など複数の AI クライアントをサポートします。 - -MCP を使うと、自然言語で「売上データを A1 から C10 に入力して」などと指示するだけで、AI が自動的に操作を実行します。 - -## 仕組み - -LLM が MCP で MCP Server を呼び出す → MCP Server が命令を実行 → WebSocket で特定ユーザーの Univer インスタンスへ指示をプッシュ。 - -この経路には 3 つのコアコンポーネントがあります。 - -- **MCP Agent（LLM クライアント）** - - ツール呼び出しを開始 - - 例：Cursor、Claude、LangChain Agent -- **MCP Server** - - ツール定義を提供 - - 指示のルーティング/中継 - - 公式クラウド：mcp.univer.ai（セルフホストも可） -- **Univer インスタンス** - - 命令を受け取り実行 - - ユーザーのブラウザ上で動作し、MCP プラグインの登録が必要 - - ツール群は `UniverSheetMCPPlugin` が自動提供（手動定義不要） - - -重要：univer-session-id によってユーザーごとの指示を分離します。 - - -**要するに**：AI に「A1 に Hello と書いて」と伝えると、MCP 経由で Univer が操作を実行し、シート上で結果を確認できます。 - -## さらに詳しく - -MCP について詳しく知りたい場合は、以下を参照してください。 - - - - diff --git a/content/guides/sheets/getting-started/mcp.mdx b/content/guides/sheets/getting-started/mcp.mdx deleted file mode 100644 index 87ce24c5..00000000 --- a/content/guides/sheets/getting-started/mcp.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MCP -icon: '#pro/Wand' ---- - -MCP (Model Context Protocol) integration enables large language models to securely operate Univer spreadsheets through standardized protocols, supporting various AI clients like Cursor, Claude, and more. - -With MCP protocol, you can directly manipulate spreadsheets using natural language instructions, such as "populate sales data in cells A1 to C10", and AI will automatically execute the corresponding operations. - -## How It Works - -LLM calls your MCP Server through MCP protocol → MCP Server executes commands → pushes instructions to specific user's Univer instance via WebSocket. - -The entire pipeline involves three core components: - -- **MCP Agent (LLM Client)** - - Initiates tool calls - - Such as Cursor, Claude, LangChain Agent -- **MCP Server** - - Provides tool definitions - - Routes and relays instructions - - Official cloud service: mcp.univer.ai; supports self-hosting -- **Univer Instance** - - Receives and executes commands - - Runs in user's browser, requires MCP plugin registration - - Tool set is automatically provided by `UniverSheetMCPPlugin`, no manual definition needed - - -Key mechanism: Multi-user instruction isolation through univer-session-id. - - -**Simply put**: You tell AI "write Hello in cell A1", AI tells Univer to execute this operation through MCP protocol, and you can see the result in the spreadsheet. - -## Learn More - -If you want to learn more about MCP, you can refer to the following resources: - - - - diff --git a/content/guides/sheets/getting-started/mcp.zh-CN.mdx b/content/guides/sheets/getting-started/mcp.zh-CN.mdx deleted file mode 100644 index bb4359d1..00000000 --- a/content/guides/sheets/getting-started/mcp.zh-CN.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MCP -icon: '#pro/Wand' ---- - -MCP（Model Context Protocol，模型上下文协议）集成功能让大模型通过标准协议安全操作 Univer 表格，支持多种 AI 客户端如 Cursor、Claude 等。 - -借助 MCP 协议，你可以用自然语言指令直接操作表格，如“将销售数据填入A1到C10”，AI 会自动执行相应操作。 - -## 工作原理 - -LLM 通过 MCP 协议调用你的 MCP Server → MCP Server 执行命令 → 通过 WebSocket 推送指令到特定用户的 Univer 实例。 - -整个链路涉及三个核心组件： - -- **MCP Agent（LLM 客户端）** - - 发起工具调用 - - 如 Cursor、Claude、LangChain Agent -- **MCP Server** - - 提供工具定义 - - 路由与中转指令 - - 官方云服务：mcp.univer.ai；支持自建 -- **Univer 实例** - - 接收并执行命令 - - 运行在用户浏览器中，需注册 MCP 插件 - - 工具集由 `UniverSheetMCPPlugin` 自动提供，无需手动定义 - - -关键机制：通过 univer-session-id 实现多用户指令隔离。 - - -**简单来说**：你对 AI 说“在 A1 单元格写入 Hello”，AI 通过 MCP 协议告诉 Univer 执行这个操作，你就能在表格中看到结果。 - -## 了解更多 - -如果你想要了解更多 MCP 相关内容，可以参考以下资源： - - - - diff --git a/content/guides/sheets/getting-started/mcp.zh-TW.mdx b/content/guides/sheets/getting-started/mcp.zh-TW.mdx deleted file mode 100644 index a2ec47a1..00000000 --- a/content/guides/sheets/getting-started/mcp.zh-TW.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MCP -icon: '#pro/Wand' ---- - -MCP（Model Context Protocol，模型上下文協議）整合功能讓大模型透過標準協議安全操作 Univer 表格，支援多種 AI 客戶端如 Cursor、Claude 等。 - -藉助 MCP 協議，你可以用自然語言指令直接操作表格，如“將銷售資料填入A1到C10”，AI 會自動執行相應操作。 - -## 工作原理 - -LLM 透過 MCP 協議呼叫你的 MCP Server → MCP Server 執行命令 → 透過 WebSocket 推送指令到特定使用者的 Univer 例項。 - -整個鏈路涉及三個核心元件： - -- **MCP Agent（LLM 客戶端）** - - 發起工具呼叫 - - 如 Cursor、Claude、LangChain Agent -- **MCP Server** - - 提供工具定義 - - 路由與中轉指令 - - 官方雲服務：mcp.univer.ai；支援自建 -- **Univer 例項** - - 接收並執行命令 - - 執行在使用者瀏覽器中，需註冊 MCP 外掛 - - 工具集由 `UniverSheetMCPPlugin` 自動提供，無需手動定義 - - -關鍵機制：透過 univer-session-id 實現多使用者指令隔離。 - - -**簡單來說**：你對 AI 說“在 A1 單元格寫入 Hello”，AI 透過 MCP 協議告訴 Univer 執行這個操作，你就能在表格中看到結果。 - -## 瞭解更多 - -如果你想要了解更多 MCP 相關內容，可以參考以下資源： - - - - diff --git a/content/guides/sheets/meta.ja-JP.json b/content/guides/sheets/meta.ja-JP.json index cda11e94..d294fd91 100644 --- a/content/guides/sheets/meta.ja-JP.json +++ b/content/guides/sheets/meta.ja-JP.json @@ -15,7 +15,6 @@ "getting-started/integrations", "getting-started/node", "getting-started/pro", - "getting-started/mcp", "---データモデル---", "model/workbook-data", "model/worksheet-data", @@ -36,7 +35,6 @@ "features/crosshair-highlighting", "features/zen", "features/uniscript", - "features/mcp", "features/advanced-formula", "features/print", "features/shapes", diff --git a/content/guides/sheets/meta.json b/content/guides/sheets/meta.json index 5d2332bc..2e0b583a 100644 --- a/content/guides/sheets/meta.json +++ b/content/guides/sheets/meta.json @@ -15,7 +15,6 @@ "getting-started/integrations", "getting-started/node", "getting-started/pro", - "getting-started/mcp", "---Data Model---", "model/workbook-data", "model/worksheet-data", @@ -36,7 +35,6 @@ "features/crosshair-highlighting", "features/zen", "features/uniscript", - "features/mcp", "features/advanced-formula", "features/print", "features/shapes", diff --git a/content/guides/sheets/meta.zh-CN.json b/content/guides/sheets/meta.zh-CN.json index e3fbb7ed..fa7a2fd6 100644 --- a/content/guides/sheets/meta.zh-CN.json +++ b/content/guides/sheets/meta.zh-CN.json @@ -15,7 +15,6 @@ "getting-started/integrations", "getting-started/node", "getting-started/pro", - "getting-started/mcp", "---数据模型---", "model/workbook-data", "model/worksheet-data", @@ -36,7 +35,6 @@ "features/crosshair-highlighting", "features/zen", "features/uniscript", - "features/mcp", "features/advanced-formula", "features/print", "features/shapes", diff --git a/content/guides/sheets/meta.zh-TW.json b/content/guides/sheets/meta.zh-TW.json index 1b3d241c..944180e3 100644 --- a/content/guides/sheets/meta.zh-TW.json +++ b/content/guides/sheets/meta.zh-TW.json @@ -15,7 +15,6 @@ "getting-started/integrations", "getting-started/node", "getting-started/pro", - "getting-started/mcp", "---資料模型---", "model/workbook-data", "model/worksheet-data", @@ -36,7 +35,6 @@ "features/crosshair-highlighting", "features/zen", "features/uniscript", - "features/mcp", "features/advanced-formula", "features/print", "features/shapes", diff --git a/content/reference/packages/plugins/meta.json b/content/reference/packages/plugins/meta.json index 4659d95c..f71fb3f0 100644 --- a/content/reference/packages/plugins/meta.json +++ b/content/reference/packages/plugins/meta.json @@ -14,13 +14,10 @@ "univerjs-pro/exchange-client", "univerjs-pro/license", "univerjs-pro/live-share", - "univerjs-pro/mcp", - "univerjs-pro/mcp-ui", "univerjs-pro/range-preprocess", "univerjs-pro/sheets-chart", "univerjs-pro/sheets-chart-ui", "univerjs-pro/sheets-exchange-client", - "univerjs-pro/sheets-mcp", "univerjs-pro/sheets-pivot", "univerjs-pro/sheets-pivot-ui", "univerjs-pro/sheets-print", diff --git a/content/reference/packages/plugins/univerjs-pro/mcp-ui.mdx b/content/reference/packages/plugins/univerjs-pro/mcp-ui.mdx deleted file mode 100644 index 1db57b08..00000000 --- a/content/reference/packages/plugins/univerjs-pro/mcp-ui.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: '@univerjs-pro/mcp-ui' -icon: '#ref/P' ---- - -```typescript -// [!code word:UniverMCPUIPlugin] -import { UniverMCPUIPlugin } from '@univerjs-pro/mcp-ui' - -univer.registerPlugin(UniverMCPUIPlugin) -``` diff --git a/content/reference/packages/plugins/univerjs-pro/mcp.mdx b/content/reference/packages/plugins/univerjs-pro/mcp.mdx deleted file mode 100644 index b598d054..00000000 --- a/content/reference/packages/plugins/univerjs-pro/mcp.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: '@univerjs-pro/mcp' -icon: '#ref/P' ---- - -```typescript -// [!code word:UniverMCPPlugin] -import { UniverMCPPlugin } from '@univerjs-pro/mcp' - -univer.registerPlugin(UniverMCPPlugin) -``` diff --git a/content/reference/packages/plugins/univerjs-pro/sheets-mcp.mdx b/content/reference/packages/plugins/univerjs-pro/sheets-mcp.mdx deleted file mode 100644 index e4a7150e..00000000 --- a/content/reference/packages/plugins/univerjs-pro/sheets-mcp.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: '@univerjs-pro/sheets-mcp' -icon: '#ref/P' ---- - -```typescript -// [!code word:UniverSheetMCPPlugin] -import { UniverSheetMCPPlugin } from '@univerjs-pro/sheets-mcp' - -univer.registerPlugin(UniverSheetMCPPlugin) -```