new tool for apps dynamic documentation #183
Open
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
- Switch from BaseMondayAppsTool to BaseMondayApiTool for consistency - Extract GraphQL query to separate file (get-app-development-context.graphql.ts) - Simplify response handling by using mondayApi.request directly - Update query to use ask_developer_docs endpoint
- Remove appDevelopmentAssistantTools from allMondayAppsTools (incompatible base class) - Add GetAppDevelopmentContextTool to allGraphqlApiTools (extends BaseMondayApiTool) - Remove unused APP_DEVELOPMENT_ASSISTANT enum value
oricho123
requested changes
Jan 20, 2026
Comment on lines
+30
to
+43
| return `Search monday.com apps documentation using AI-powered semantic search. | ||
| This tool provides accurate, contextual answers about: | ||
| - Building app features (board views, item views, dashboard widgets, custom columns) | ||
| - OAuth scopes and permissions (boards:read, boards:write, users:read, etc.) | ||
| - monday.com SDK reference and usage examples | ||
| - monday-code deployment instructions (including 'mapps code:push') | ||
| - Connecting deployments to app features (mapps app-features:build) | ||
| - monday-code deployment and integration | ||
| - Vibe Design System components and styling | ||
| - Best practices for performance, security, and error handling | ||
| - Troubleshooting common issues | ||
| - CLI commands reference | ||
| - Workflow blocks, custom triggers, and automation actions | ||
| - Custom objects and data schemas | ||
| - Best practices, troubleshooting, and common patterns | ||
| Use this tool when you need to: | ||
| - Help users build or modify monday.com apps | ||
| - Determine which OAuth scopes an app needs based on its functionality | ||
| - Guide users through deploying to monday-code | ||
| - Connect deployed code to app features | ||
| - Provide SDK usage examples and patterns | ||
| - Build UIs with Vibe components | ||
| - Create workflow automations with custom triggers/actions | ||
| - Implement custom objects and relationships | ||
| - Troubleshoot app development issues | ||
| The context includes code examples for: | ||
| - Board views, item views, dashboard widgets | ||
| - Custom columns and integrations | ||
| - Vibe components (Button, TextField, Dropdown, Modal, Toast, etc.) | ||
| - Workflow blocks with input/output field definitions | ||
| - Custom objects with schemas and CRUD operations | ||
| - API calls, storage, and webhooks | ||
| - OAuth scope configuration via manifest | ||
| - Deployment and connecting features to deployments`; | ||
| Use this when you need specific information from the official monday.com apps documentation. | ||
| Provide a clear question or topic in the query parameter for best results.`; |
Collaborator
There was a problem hiding this comment.
Didn't we shorten it too much?
| .optional() | ||
| .describe( | ||
| 'Optional specific topic to focus on within the context (e.g., "board views", "custom columns", "integrations", "OAuth", "storage API")', | ||
| 'The question or topic to search in the monday.com apps documentation. Be specific for better results. Examples: "How do I create a board view?", "What OAuth scopes do I need for reading boards?", "How to deploy to monday-code?", "Vibe Button component usage"', |
Collaborator
There was a problem hiding this comment.
do we really know how to answer
Vibe Button component usage?
| } | ||
|
|
||
| export class GetAppDevelopmentContextTool extends BaseMondayAppsTool< | ||
| export class GetAppDevelopmentContextTool extends BaseMondayApiTool< |
Collaborator
There was a problem hiding this comment.
doesnt this change means you won't get this tool when using mode --apps???
| CreateWidgetTool, | ||
| BoardInsightsTool, | ||
| SearchTool, | ||
| // App Development Assistant (uses BaseMondayApiTool) |
| BoardInsightsTool, | ||
| SearchTool, | ||
| // App Development Assistant (uses BaseMondayApiTool) | ||
| GetAppDevelopmentContextTool, |
Collaborator
There was a problem hiding this comment.
But this is not good that it's here :(
Shaharshaki2
force-pushed
the
feat/shaharsh/new-tool-for-apps-documentation-kapa-ai
branch
from
f276950 to
a51fccb
Compare
- Add MONDAY_API_GRAPHQL endpoint (api.monday.com/v2) for platform queries - Update executeGraphQLQuery to use the correct endpoint - Fix 404 error when calling ask_developer_docs
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.
Using new query for getting apps documentation for ai assisted tool