Skip to content

britus/MCPStudio_ToolSDK

Repository files navigation

MCPStudio_ToolSDK

Official SDK of the EoF MCP Studio App for macOS

Overview

The MCPStudio_ToolSDK provides a comprehensive framework for building custom tools, plugins, and scripts for the MCP Studio application. This SDK enables developers to extend MCP Studio functionality through:

  • JavaScript Scripting - Full API access via built-in utilities
  • C/C++ Plugins - Build dynamic libraries (dylib) and bundles
  • Build Integration - CMake, Xcode, QMake support
  • File Operations - Secure file access with macOS sandboxing
  • HTTP Tools - REST API client for network operations
  • Build Automation - Project build management utilities

SDK Structure

MCPStudio_ToolSDK/
├── Scripts/                    # JavaScript utility scripts
│   ├── clangTools.js          # Clang compiler tools
│   ├── cmakeBuild.js          # CMake build automation
│   ├── checkWithXcode.js      # Xcode project validation
│   ├── fileRead.js            # File reading utilities
│   ├── fileSave.js            # File writing utilities
│   ├── shellCall.js           # Shell command execution
│   ├── httpTools.js           # HTTP request utilities
│   ├── directoryList.js       # Directory listing operations
│   ├── directoryCreate.js     # Directory creation utilities
│   └── tool_entry.js          # Tool entry point registry
├── SamplePlugin/              # Sample plugin template
│   ├── dylib/                 # Dynamic library implementation
│   ├── bundle/                # Bundle implementation
│   ├── CMakeLists.txt         # Master build configuration
│   └── ToolCapabilities.json  # Plugin capabilities definition
├── test-scripts/             # Test suite for utilities
│   ├── testFileOps.js        # File operation tests
│   ├── testHttpAll.js        # HTTP method tests
│   ├── testJSON.js           # JSON handling tests
│   └── ...                   # Additional test scripts
└── README*.md               # Documentation files

## Quick Start Guide

### 1. Build a Sample Plugin

```bash
cd SamplePlugin
mkdir build
cd build
cmake ..
make

This generates both SampleTool dylib and SampleTool.bundle.

2. Create Custom Tool Scripts

Add scripts to the Scripts/ directory:

// Example: customTools.js
function toolEntry(sid, toolName, params, resultJson, resultSize) {
    // Your tool implementation here
    return null;
}

module.exports = {
    toolEntry
};

3. Execute via MCP Studio

Use the MCP Studio UI to:

  • Configure custom tools in Tools/ directory
  • Load scripts from Scripts/ directory
  • Execute with parameters and view results

API Reference

File Operations

Build Tools

Shell Utilities

Directory Operations

HTTP Tools

Core Utilities

Documentation Links

Handler Components

  • README-Handler.md - Detailed handler components documentation including MyResourceHandler and FileAccessHandler

Scripting System

Sample Plugin

Server Implementation

Project Structure Summary

MCPStudio_ToolSDK/

  • Scripts/ - JavaScript utilities for file operations, build tools, shell commands, HTTP requests
  • SamplePlugin/ - CMake-based plugin template with dylib and bundle implementations
  • test-scripts/ - Test suite for validating utility functions

Key Features

JavaScript Scripting Integration

  • Full API access to file system, build tools, HTTP client
  • Parameterized tool execution with logging
  • Secure macOS sandbox support

Plugin System

  • Support for dynamic libraries (.dylib) and bundles (.bundle)
  • CMake-based build configuration
  • Tool descriptor registration via toolDescribe()
  • ABI-compliant entry points (toolEntry, toolExecute)

Build Automation

  • CMake project builds with custom flags
  • Xcode project validation and building
  • QMake support for Qt projects
  • GCC/Clang compiler integration

Secure Operations

  • macOS security-scoped file access
  • Plugin loading with secure bookmarks
  • Sandboxed execution environment

Configuration

The MCP Studio application uses the following configuration directories:

Tools/     - Custom tool configurations
Resources/ - Resource definitions
Prompts/   - Prompt templates and configurations

Getting Started

  1. Clone or navigate to the SDK directory
  2. Review the README files linked above for detailed documentation
  3. Build the SamplePlugin to understand plugin structure
  4. Create custom scripts in the Scripts/ directory
  5. Configure tools via MCP Studio App or configuration files

License

Copyright (C) 2026 EoF Software Lab. All rights reserved.


Last updated: 2026 | SDK Version: 1.0

About

Official SDK of the EoF MCP Studio App for macOS

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors