{"type":"mcp_client","name":"openmcp-client","description":"**Concise Descriptions (under 200 characters):**\n\n* **OpenMCP client: VS Code extension for MCP development. Streamlines workflow & enhances developer experience.** (100 characters)\n* **VS Code plugin","category":"AI","language":"Vue","stars":749,"forks":31,"owner":"LSTM-Kirigaya","github_url":"https://github.com/LSTM-Kirigaya/openmcp-client","homepage":"https://kirigaya.cn/openmcp","setup":"## Setup\n\nThis guide provides instructions for setting up and running OpenMCP. It covers both the `openmcp-client` development environment and the `openmcp-sdk` for deploying MCP agents.\n\n### Prerequisites\n\n*   **Node.js and npm:** Ensure you have Node.js and npm (Node Package Manager) installed on your system.  A recent version of Node.js (v18 or higher) is recommended. You can download it from [nodejs.org](https://nodejs.org/).\n\n### openmcp-sdk Installation\n\nThe `openmcp-sdk` is used for deploying your MCP as an agent application.\n\n1.  **Install the SDK:**\n\n    ```bash\n    npm install openmcp-sdk\n    ```\n\n2.  **Deploy your agent:**\n\n    Create a TypeScript file (e.g., `agent.ts`) with the following code:\n\n    ```typescript\n    import { OmAgent } from 'openmcp-sdk/service/sdk';\n\n    // create Agent\n    const agent = new OmAgent();\n\n    // Load configuration, which can be automatically generated after debugging with openmcp client\n    agent.loadMcpConfig('./mcpconfig.json');\n\n    // Read the debugged prompt\n    const prompt = await agent.getPrompt('hacknews', { topn: '5' });\n\n    // Execute the task\n    const res = await agent.ainvoke({ messages: prompt });\n\n    console.log('⚙️ Agent Response', res);\n    ```\n\n3.  **Run your agent:**\n\n    ```bash\n    # Compile the TypeScript file (if needed)\n    npx tsc agent.ts\n\n    # Run the compiled JavaScript file\n    node agent.js\n    ```\n\n    **Note:** You'll need a `mcpconfig.json` file. This file can be automatically generated after debugging with the `openmcp-client`.  Ensure the path to this file in `agent.loadMcpConfig('./mcpconfig.json');` is correct.\n\n### Renderer & Service Development (for Plugin/Web Development)\n\nThese instructions are for developing the OpenMCP renderer and service components, typically for plugin or web development.\n\n1.  **Project Setup:**\n\n    ```bash\n    npm run setup\n    ```\n\n    This command likely installs dependencies and performs initial setup tasks.  Refer to the project's `package.json` file for the exact scripts executed by `npm run setup`.\n\n2.  **Start Dev Server:**\n\n    ```bash\n    npm run serve\n    ```\n\n    This command starts a development server for the renderer and service.  It likely uses tools like Webpack or Parcel to bundle and serve the application.  The server address will be displayed in the console.\n\n### Extension Development (VSCode Plugin)\n\nThese instructions are for developing the OpenMCP VSCode extension.\n\n1.  **Build for Deployment:**\n\n    ```bash\n    npm run build\n    ```\n\n    This command builds the renderer and service components for deployment within the VSCode extension.\n\n2.  **Build VSCode Extension:**\n\n    ```bash\n    npm run build:plugin\n    ```\n\n    This command packages the necessary files into a VSCode extension package.\n\n3.  **Run in VSCode:**\n\n    Press `F5` in VSCode to start the extension in debug mode. This will open a new VSCode window with the extension loaded.\n\n### Configuration Requirements\n\n*   **`mcpconfig.json`:**  The `openmcp-sdk` requires a `mcpconfig.json` file that contains the configuration for your MCP server. This file is typically generated by the `openmcp-client` after debugging.  Ensure the path to this file is correctly specified in your code.\n\n### Environment Variables\n\nThe README doesn't explicitly mention environment variables. However, depending on the specific MCP server and large model integrations you are using, you might need to set environment variables for API keys, authentication tokens, or other configuration parameters.  Refer to the documentation for your specific MCP server and large model providers for details.","tools":"## Available Tools\n\nOpenMCP provides a suite of tools and features designed to streamline the development, testing, and deployment of MCP (presumably, Multi-Cloud Platform or similar) applications. These tools are primarily delivered through two components: `openmcp-client` and `openmcp-sdk`.\n\n### openmcp-client\n\nThe `openmcp-client` is an integrated environment for developing and testing MCP applications. It combines an inspector with basic MCP client functions, allowing for simultaneous development and testing.\n\n*   **Integrated Inspector:** Provides insights into the MCP application's behavior, allowing developers to debug and optimize performance.\n*   **MCP Client Basic Functions:** Enables interaction with MCP servers, facilitating testing and development workflows.\n*   **Resource Testing:** Offers tools, prompts, and resources for testing various aspects of the MCP application.\n*   **Interactive Testing Module:** Allows for large model interaction testing, enabling developers to evaluate the application's performance with different models.\n*   **Project-Level Management Panel:** Simplifies MCP project management at both project and global levels, providing a centralized interface for managing resources and configurations.\n*   **Multiple Large Model Support:** Supports integration with various large language models (LLMs), allowing developers to leverage different models for their MCP applications.\n*   **XML Mode and Customized Options:** Offers flexibility in tool selection through XML mode and customizable options, enabling developers to tailor the environment to their specific needs.\n\n### openmcp-sdk\n\nThe `openmcp-sdk` facilitates the deployment of MCP applications as agent apps after they have been tested and verified in `openmcp-client`.\n\n*   **Agent App Deployment:** Enables the rapid and easy deployment of MCP applications as agent apps.\n\n    **Usage Example:**\n\n    ```bash\n    npm install openmcp-sdk\n    ```\n\n    ```typescript\n    import { OmAgent } from 'openmcp-sdk/service/sdk';\n\n    // create Agent\n    const agent = new OmAgent();\n        \n    // Load configuration, which can be automatically generated after debugging with openmcp client\n    agent.loadMcpConfig('./mcpconfig.json');\n\n    // Read the debugged prompt\n    const prompt = await agent.getPrompt('hacknews', { topn: '5' });    \n\n    // Execute the task\n    const res = await agent.ainvoke({ messages: prompt });\n\n    console.log('⚙️ Agent Response', res);\n    ```\n\n### Other Features (Roadmap)\n\nThe project roadmap outlines several planned features, including:\n\n*   Cost analysis in chat mode.\n*   Basic MCP project management.\n*   Custom OpenAI-compatible large model integration.\n*   Custom protocol large model integration.\n*   Simultaneous debugging of multiple MCP Servers.\n*   Online verification via large models.\n*   Saving user's server debugging work.\n*   High-risk operation permission confirmation.\n*   Hot update for connected MCP servers.\n*   Cloud sync for system configuration.\n*   System prompt management module.\n*   Tool-wise logging system.\n*   MCP security checks (prevent prompt injection, etc.).\n*   Built-in OCR for character recognition.","faq":null,"created_at":"2025-03-22T10:37:48+00:00","updated_at":"2025-08-08T04:16:38+00:00","source_url":"https://model-context-protocol.com/clients/openmcp-client","related_articles":[]}