feat(server): add read doc tool #12811
Open
+102
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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 ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## ai-editable-markdown-format #12811 +/- ##
===============================================================
+ Coverage 55.67% 55.88% +0.21%
===============================================================
Files 2658 2659 +1
Lines 126088 126190 +102
Branches 19973 20032 +59
===============================================================
+ Hits 70197 70521 +324
+ Misses 53630 53321 -309
- Partials 2261 2348 +87
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:
|
fengmk2
changed the base branch from
fengmk2/read-doc-markdown
to
read-doc-markdown
fengmk2
force-pushed
the
read-doc-markdown
branch
from
03e15d8 to
dd21429
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
3 times, most recently
from
d1416e6 to
6c7ec97
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
from
e9acb88 to
416d507
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
6c7ec97 to
729c8e8
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
from
416d507 to
4dd7854
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
729c8e8 to
a5f73b9
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
from
4dd7854 to
9d6ee14
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
a5f73b9 to
9541597
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
from
9d6ee14 to
016adc0
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
9541597 to
1ba4569
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
from
016adc0 to
a9e4dd0
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
1ba4569 to
a186b28
Compare
fengmk2
force-pushed
the
read-doc-markdown
branch
2 times, most recently
from
e4d26eb to
541a2cc
Compare
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
2 times, most recently
from
df48490 to
3893e0e
Compare
fengmk2
changed the base branch from
read-doc-markdown
to
ai-editable-markdown-format
fengmk2
force-pushed
the
fengmk2/ai-read-doc-tool
branch
from
3893e0e to
4a34a09
Compare
fengmk2
requested review from
Copilot,
darkskygit and
akumatus
and removed request for
Copilot and
darkskygit
There was a problem hiding this comment.
Pull Request Overview
Adds a new Copilot tool for reading document content directly within the workspace.
- Introduces
doc-readtool implementation intools/doc-read.ts - Integrates the new tool into Copilot’s utilities and provider setup
- Exposes the tool in the tools index for discovery
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/backend/server/src/plugins/copilot/tools/index.ts | Export new doc-read tool |
| packages/backend/server/src/plugins/copilot/tools/doc-read.ts | Add buildDocContentGetter and createDocReadTool |
| packages/backend/server/src/plugins/copilot/providers/utils.ts | Import and register doc_read in CustomAITools |
| packages/backend/server/src/plugins/copilot/providers/provider.ts | Wire up docRead in provider switch |
Comments suppressed due to low confidence (2)
packages/backend/server/src/plugins/copilot/tools/doc-read.ts:1
- No tests were added for the new doc-read tool. Consider adding unit tests for both
buildDocContentGetter(authorized, unauthorized, missing doc) andcreateDocReadTool(successful read, error handling).
import { Logger } from '@nestjs/common';
packages/backend/server/src/plugins/copilot/tools/doc-read.ts:12
- Add JSDoc or comments to explain
buildDocContentGetterparameters and return value so future maintainers understand its contract and side effects.
export const buildDocContentGetter = (
Comment on lines
+55
to
+63
| ...content, | ||
| ...docMeta, | ||
| }; | ||
| }; | ||
| return getDoc; | ||
| }; | ||
|
|
||
| export const createDocReadTool = ( | ||
| getDoc: (targetId?: string) => Promise<object | undefined> |
There was a problem hiding this comment.
The tool's return type is currently object | undefined. Defining a specific interface for the doc payload (e.g. DocReadResult) will improve type safety and clarity.
Suggested change
| ...content, | |
| ...docMeta, | |
| }; | |
| }; | |
| return getDoc; | |
| }; | |
| export const createDocReadTool = ( | |
| getDoc: (targetId?: string) => Promise<object | undefined> | |
| createdAt: docMeta.createdAt, | |
| updatedAt: docMeta.updatedAt, | |
| createdByUser: docMeta.createdByUser, | |
| updatedByUser: docMeta.updatedByUser, | |
| markdownContent: content, | |
| }; | |
| }; | |
| return getDoc; | |
| }; | |
| export const createDocReadTool = ( | |
| getDoc: (targetId?: string) => Promise<DocReadResult | undefined> |
Copilot uses AI. Check for mistakes.
| @@ -10,6 +10,7 @@ import { | |||
| import { ZodType } from 'zod'; | |||
|
|
|||
| import { | |||
| createDocReadTool, | |||
There was a problem hiding this comment.
[nitpick] Consider grouping and ordering imports alphabetically (or per project style) to keep the import block organized as more tools are added.
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close AI-186
PR Dependency Tree
This tree was auto-generated by Charcoal