feat(server): basic mcp server #13298
Conversation
|
Warning Rate limit exceeded@forehalo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 15 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (9)
WalkthroughThis change introduces a new Model Context Protocol (MCP) integration into the backend server. It adds a new dependency, defines provider and controller classes for MCP functionality, registers new tools for document access and search, and refactors utility functions for embedding chunk processing. Import statements and constant definitions are updated accordingly. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant WorkspaceMcpController
participant WorkspaceMcpProvider
participant McpServer
participant StreamableHTTPServerTransport
Client->>WorkspaceMcpController: POST /api/workspaces/:workspaceId/mcp
WorkspaceMcpController->>WorkspaceMcpProvider: for(userId, workspaceId)
WorkspaceMcpProvider->>McpServer: create instance, register tools
WorkspaceMcpProvider-->>WorkspaceMcpController: return McpServer
WorkspaceMcpController->>StreamableHTTPServerTransport: create instance
WorkspaceMcpController->>McpServer: connect(transport)
WorkspaceMcpController->>StreamableHTTPServerTransport: handleRequest(req, res, body)
Note right of WorkspaceMcpController: On response close, clean up resources
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## canary #13298 +/- ##
==========================================
- Coverage 57.37% 57.29% -0.09%
==========================================
Files 2712 2714 +2
Lines 133675 133918 +243
Branches 20756 20757 +1
==========================================
+ Hits 76698 76728 +30
+ Misses 55313 54986 -327
- Partials 1664 2204 +540
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
packages/backend/server/src/plugins/copilot/mcp/provider.ts (2)
148-153: Consider returning structured data instead of JSON stringsEach document is individually JSON stringified, which requires clients to parse each string separately. Consider returning structured data or stringifying the entire array.
return { content: docs.map(doc => ({ type: 'text', - text: JSON.stringify(pick(doc, 'docId', 'title', 'createdAt')), + text: `${doc.title} (ID: ${doc.docId}, Created: ${doc.createdAt})`, })), };Or if JSON is required:
return { - content: docs.map(doc => ({ - type: 'text', - text: JSON.stringify(pick(doc, 'docId', 'title', 'createdAt')), - })), + content: [{ + type: 'text', + text: JSON.stringify(docs.map(doc => pick(doc, 'docId', 'title', 'createdAt'))), + }], };
84-128: Consider consistent AbortSignal support across toolsThe Semantic Search tool accepts and uses an AbortSignal (line 102), but the Keyword Search tool doesn't. For consistency and better cancellation support, consider adding signal support to all tools.
- async ({ query }) => { + async ({ query }, req) => { query = query.trim(); if (!query) { return { isError: true, content: [ { type: 'text', text: 'Query is required for keyword search.', }, ], }; } - let docs = await this.indexer.searchDocsByKeyword(workspaceId, query); + let docs = await this.indexer.searchDocsByKeyword(workspaceId, query, req.signal);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (9)
packages/backend/server/package.json(1 hunks)packages/backend/server/src/plugins/copilot/context/resolver.ts(1 hunks)packages/backend/server/src/plugins/copilot/index.ts(2 hunks)packages/backend/server/src/plugins/copilot/mcp/controller.ts(1 hunks)packages/backend/server/src/plugins/copilot/mcp/provider.ts(1 hunks)packages/backend/server/src/plugins/copilot/tools/doc-semantic-search.ts(1 hunks)packages/backend/server/src/plugins/copilot/types.ts(0 hunks)packages/backend/server/src/plugins/copilot/utils.ts(2 hunks)packages/backend/server/src/plugins/copilot/workspace/resolver.ts(1 hunks)
🧬 Code Graph Analysis (2)
packages/backend/server/src/plugins/copilot/utils.ts (1)
packages/backend/server/src/models/common/copilot.ts (1)
ChunkSimilarity(96-100)
packages/backend/server/src/plugins/copilot/mcp/provider.ts (3)
packages/backend/server/src/plugins/copilot/context/index.ts (1)
CopilotContextService(2-2)packages/backend/server/src/plugins/indexer/index.ts (1)
IndexerService(28-28)packages/backend/server/src/plugins/copilot/utils.ts (1)
clearEmbeddingChunk(63-79)
💤 Files with no reviewable changes (1)
- packages/backend/server/src/plugins/copilot/types.ts
🧰 Additional context used
🧬 Code Graph Analysis (2)
packages/backend/server/src/plugins/copilot/utils.ts (1)
packages/backend/server/src/models/common/copilot.ts (1)
ChunkSimilarity(96-100)
packages/backend/server/src/plugins/copilot/mcp/provider.ts (3)
packages/backend/server/src/plugins/copilot/context/index.ts (1)
CopilotContextService(2-2)packages/backend/server/src/plugins/indexer/index.ts (1)
IndexerService(28-28)packages/backend/server/src/plugins/copilot/utils.ts (1)
clearEmbeddingChunk(63-79)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (53)
- GitHub Check: y-octo binding test on x86_64-unknown-linux-gnu
- GitHub Check: fuzzing
- GitHub Check: y-octo binding test on x86_64-pc-windows-msvc
- GitHub Check: y-octo binding test on aarch64-apple-darwin
- GitHub Check: y-octo binding test on aarch64-unknown-linux-gnu
- GitHub Check: y-octo binding test on x86_64-apple-darwin
- GitHub Check: y-octo binding test on aarch64-pc-windows-msvc
- GitHub Check: E2E Mobile Test (5)
- GitHub Check: E2E Mobile Test (3)
- GitHub Check: E2E Mobile Test (4)
- GitHub Check: Run native tests
- GitHub Check: E2E Mobile Test (1)
- GitHub Check: E2E Mobile Test (2)
- GitHub Check: Build @affine/electron renderer
- GitHub Check: E2E BlockSuite Cross Browser Test (2, chromium)
- GitHub Check: E2E BlockSuite Cross Browser Test (1, firefox)
- GitHub Check: E2E Test (7)
- GitHub Check: Lint Rust
- GitHub Check: E2E BlockSuite Cross Browser Test (2, webkit)
- GitHub Check: E2E Test (9)
- GitHub Check: E2E BlockSuite Cross Browser Test (2, firefox)
- GitHub Check: E2E BlockSuite Cross Browser Test (1, chromium)
- GitHub Check: E2E BlockSuite Cross Browser Test (1, webkit)
- GitHub Check: E2E BlockSuite Test (2)
- GitHub Check: E2E Test (10)
- GitHub Check: E2E Test (8)
- GitHub Check: Build Server native
- GitHub Check: E2E Test (6)
- GitHub Check: E2E Test (1)
- GitHub Check: E2E Test (2)
- GitHub Check: E2E BlockSuite Test (9)
- GitHub Check: E2E Test (5)
- GitHub Check: E2E Test (4)
- GitHub Check: E2E BlockSuite Test (8)
- GitHub Check: E2E BlockSuite Test (10)
- GitHub Check: E2E BlockSuite Test (7)
- GitHub Check: E2E Test (3)
- GitHub Check: E2E BlockSuite Test (3)
- GitHub Check: E2E BlockSuite Test (6)
- GitHub Check: E2E BlockSuite Test (1)
- GitHub Check: loom thread test
- GitHub Check: E2E BlockSuite Test (5)
- GitHub Check: E2E BlockSuite Test (4)
- GitHub Check: Build AFFiNE native (x86_64-pc-windows-msvc)
- GitHub Check: Build AFFiNE native (aarch64-pc-windows-msvc)
- GitHub Check: Analyze (typescript, affine)
- GitHub Check: Build AFFiNE native (x86_64-apple-darwin)
- GitHub Check: Build AFFiNE native (aarch64-apple-darwin)
- GitHub Check: Build AFFiNE native (x86_64-unknown-linux-gnu)
- GitHub Check: Analyze (typescript, blocksuite)
- GitHub Check: Analyze (javascript, affine)
- GitHub Check: Typecheck
- GitHub Check: Analyze (javascript, blocksuite)
🔇 Additional comments (12)
packages/backend/server/src/plugins/copilot/workspace/resolver.ts (1)
30-30: LGTM: Import consolidation looks good.The import path change from
../typesto../utilsforMAX_EMBEDDABLE_SIZEaligns with the refactoring effort to consolidate utility constants.packages/backend/server/package.json (1)
43-43: Confirmed latest version and security status
npm view @modelcontextprotocol/sdkreports 1.16.0 as the current release.- An isolated
npm auditon a clean install of v1.16.0 shows zero vulnerabilities.No further action needed—this dependency addition is up to date and has no known NPM‐level issues.
packages/backend/server/src/plugins/copilot/context/resolver.ts (1)
53-53: LGTM: Clean import consolidation.The consolidation of imports from separate modules (
../typesand../utils) into a single import from../utilsimproves code organization and is consistent with the refactoring pattern across the codebase.packages/backend/server/src/plugins/copilot/tools/doc-semantic-search.ts (1)
10-10: LGTM: Good refactoring to use shared utility function.Replacing the local
clearEmbeddingChunkdefinition with an import from the shared../utilsmodule promotes code reuse and consistency across the codebase.packages/backend/server/src/plugins/copilot/index.ts (3)
20-21: LGTM: Proper import additions for MCP integration.The new imports for
WorkspaceMcpControllerandWorkspaceMcpProviderare correctly added to support the MCP functionality.
83-84: LGTM: Correct provider registration.The
WorkspaceMcpProvideris properly added to the providers array with appropriate commenting for organization.
86-86: LGTM: Proper controller registration.The
WorkspaceMcpControlleris correctly added to the controllers array alongside the existingCopilotController.packages/backend/server/src/plugins/copilot/mcp/controller.ts (1)
21-24: Confirm Stateless Configuration for MCP TransportSetting
sessionIdGeneratortoundefineddisables session‐ID generation and switches the transport into fully stateless mode. In this mode, the server will:
- Not track or resume client sessions
- Treat each request as independent (no context is carried over)
- Lose features that rely on session state (e.g., resumability, client-specific data handling)
Please verify that you intend to operate in stateless mode. If you require stateful behavior—such as session resumption or per-client context—you should provide a valid
sessionIdGeneratorfunction instead ofundefined.File to review:
packages/backend/server/src/plugins/copilot/mcp/controller.ts(around line 23)packages/backend/server/src/plugins/copilot/utils.ts (1)
63-79: LGTM! Well-implemented chunk cleaning functionThe function correctly removes metadata lines while preserving immutability and handling edge cases.
packages/backend/server/src/plugins/copilot/mcp/provider.ts (3)
22-28: Good security practice with permission checkThe method properly validates user access before creating the MCP server instance.
30-76: Well-implemented tool with proper access controlThe Read Document tool correctly:
- Validates access permissions before reading
- Returns consistent error messages that don't leak access information
- Handles both not found and permission denied cases uniformly
113-119: Verify CallToolResult.content structureFile: packages/backend/server/src/plugins/copilot/mcp/provider.ts
Lines: 113–119return { content: docs.map(doc => ({ type: 'text', text: clearEmbeddingChunk(doc).content, })), };Ensure this object shape matches the
CallToolResultinterface imported from@modelcontextprotocol/sdk/types.js. In particular, confirm that each item incontentuses the exact property names and includes any required fields (e.g., metadata, source identifiers) as defined byCallToolResult. Adjust the mapping if additional properties are expected.
affine-toeverythingBundle maindiff ------------------- Bundle Size Diff -------------------------
@@ EntryPoint: index @@
## canary 61/mcp +/- ##
===================================================================
> Bundle 27.8 MB 27.8 MB -7.7 kB(-0.03%)
> Initial JS 13.2 MB 13.2 MB -8.1 kB(-0.06%)
= Initial CSS 346 kB 346 kB
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
= Assets 95 95
= Chunks 93 93
= Packages 269 269
= Duplicates 5 5
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Warnings ~~~~~~~~~~~~~~~~~~~~~~~~~~~#
! Deduplicate versions of libraries
! Separate mixed content assets files
! Avoid cache wasting
|
forehalo
force-pushed
the
61/mcp
branch
2 times, most recently
from
73348a1 to
cadb17a
Compare
forehalo
force-pushed
the
61/mcp
branch
2 times, most recently
from
579f384 to
c769279
Compare
Summary by CodeRabbit
New Features
/api/workspaces/:workspaceId/mcp, enabling advanced document reading and search capabilities within workspaces.Improvements
Chores