Official mcp server#1720
Open
AbdelrahmanELBORGY wants to merge 2 commits into
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
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.
Feature: Official Model Context Protocol (MCP) Server via
mcp_dartand NPM BridgeDescription
This PR introduces the official Model Context Protocol (MCP) server for API Dash, enabling AI assistants (specifically VS Code extensions like Roo Code and Cline) to natively interact with API Dash's core engine.
To achieve a production-ready, spec-compliant architecture, this implementation transitions to using the
mcp_dartpackage for internal protocol handling and introduces a lightweight NPM wrapper to allow seamless execution vianpx.The official bridge package is now live on NPM: apidash-mcp.
Architectural Approach
1. The Dart Engine (
mcp_dart)Instead of manually parsing and serializing JSON-RPC messages, the API Dash headless engine now utilizes the
mcp_dartpackage.--mcp-engineflag, the Flutter app bypasses the UI and boots purely as a standard I/O server.2. The Node.js Bridge (
apidash-mcp)The
apidash-mcpNode wrapper:npx -y apidash-mcp@latest.APIDASH_PATHenvironment variable.How to Use the Server
To test and use the MCP server, you do not need to compile the Node wrapper locally. You can use the globally available NPM package.
Prerequisites
Integration with VS Code (Roo Code / Cline)
Add the following configuration to your
mcp.jsonfile. Ensure theAPIDASH_PATHpoints exactly to your compiled executable.{ "servers": { "apidash": { "command": "npx", "args": [ "-y", "apidash-mcp@latest" ], "env": { "APIDASH_PATH": "C:\\Path\\To\\Your\\apidash\\build\\windows\\x64\\runner\\Release\\apidash.exe" } } } }