mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-14 09:05:04 -05:00
Compare commits
2 Commits
binary-npx
...
feat/add-g
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9a2092ffd6 | ||
|
|
5fcf3df882 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -18,6 +18,9 @@ node_modules
|
||||
# coverage
|
||||
.coverage
|
||||
|
||||
# python
|
||||
__pycache__/
|
||||
|
||||
# executable
|
||||
genai-toolbox
|
||||
toolbox
|
||||
108
GEMINI.md
Normal file
108
GEMINI.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# MCP Toolbox Context
|
||||
|
||||
This file (symlinked as `CLAUDE.md` and `AGENTS.md`) provides context and guidelines for AI agents working on the MCP Toolbox for Databases project. It summarizes key information from `CONTRIBUTING.md` and `DEVELOPER.md`.
|
||||
|
||||
## Project Overview
|
||||
|
||||
**MCP Toolbox for Databases** is a Go-based project designed to provide Model Context Protocol (MCP) tools for various data sources and services. It allows Large Language Models (LLMs) to interact with databases and other tools safely and efficiently.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Language:** Go (1.23+)
|
||||
- **Documentation:** Hugo (Extended Edition v0.146.0+)
|
||||
- **Containerization:** Docker
|
||||
- **CI/CD:** GitHub Actions, Google Cloud Build
|
||||
- **Linting:** `golangci-lint`
|
||||
|
||||
## Key Directories
|
||||
|
||||
- `cmd/`: Application entry points.
|
||||
- `internal/sources/`: Implementations of database sources (e.g., Postgres, BigQuery).
|
||||
- `internal/tools/`: Implementations of specific tools for each source.
|
||||
- `tests/`: Integration tests.
|
||||
- `docs/`: Project documentation (Hugo site).
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.23 or later.
|
||||
- Docker (for building container images and running some tests).
|
||||
- Access to necessary Google Cloud resources for integration testing (if applicable).
|
||||
|
||||
### Building and Running
|
||||
|
||||
1. **Build Binary:** `go build -o toolbox`
|
||||
2. **Run Server:** `go run .` (Listens on port 5000 by default)
|
||||
3. **Run with Help:** `go run . --help`
|
||||
4. **Test Endpoint:** `curl http://127.0.0.1:5000`
|
||||
|
||||
### Testing
|
||||
|
||||
- **Unit Tests:** `go test -race -v ./cmd/... ./internal/...`
|
||||
- **Integration Tests:**
|
||||
- Run specific source tests: `go test -race -v ./tests/<source_dir>`
|
||||
- Example: `go test -race -v ./tests/alloydbpg`
|
||||
- Add new sources to `.ci/integration.cloudbuild.yaml`
|
||||
- **Linting:** `golangci-lint run --fix`
|
||||
|
||||
## Developing Documentation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Hugo (Extended Edition v0.146.0+)
|
||||
- Node.js (for `npm ci`)
|
||||
|
||||
### Running Local Server
|
||||
|
||||
1. Navigate to `.hugo` directory: `cd .hugo`
|
||||
2. Install dependencies: `npm ci`
|
||||
3. Start server: `hugo server`
|
||||
|
||||
### Versioning Workflows
|
||||
|
||||
1. **Deploy In-development docs**: Merges to main -> `/dev/`.
|
||||
2. **Deploy Versioned Docs**: New Release -> `/<version>/` and root.
|
||||
3. **Deploy Previous Version Docs**: Manual workflow for older versions.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
### Tool Naming
|
||||
|
||||
- **Tool Name:** `snake_case` (e.g., `list_collections`, `run_query`).
|
||||
- Do *not* include the product name (e.g., avoid `firestore_list_collections`).
|
||||
- **Tool Type:** `kebab-case` (e.g., `firestore-list-collections`).
|
||||
- *Must* include the product name.
|
||||
|
||||
### Branching and Commits
|
||||
|
||||
- **Branch Naming:** `feat/`, `fix/`, `docs/`, `chore/` (e.g., `feat/add-gemini-md`).
|
||||
- **Commit Messages:** [Conventional Commits](https://www.conventionalcommits.org/) format.
|
||||
- Format: `<type>(<scope>): <description>`
|
||||
- Example: `feat(source/postgres): add new connection option`
|
||||
- Types: `feat`, `fix`, `docs`, `chore`, `test`, `ci`, `refactor`, `revert`, `style`.
|
||||
|
||||
## Adding New Features
|
||||
|
||||
### Adding a New Data Source
|
||||
|
||||
1. Create a new directory: `internal/sources/<newdb>`.
|
||||
2. Define `Config` and `Source` structs in `internal/sources/<newdb>/<newdb>.go`.
|
||||
3. Implement `SourceConfig` interface (`SourceConfigType`, `Initialize`).
|
||||
4. Implement `Source` interface (`SourceType`).
|
||||
5. Implement `init()` to register the source.
|
||||
6. Add unit tests in `internal/sources/<newdb>/<newdb>_test.go`.
|
||||
|
||||
### Adding a New Tool
|
||||
|
||||
1. Create a new directory: `internal/tools/<newdb>/<toolname>`.
|
||||
2. Define `Config` and `Tool` structs.
|
||||
3. Implement `ToolConfig` interface (`ToolConfigType`, `Initialize`).
|
||||
4. Implement `Tool` interface (`Invoke`, `ParseParams`, `Manifest`, `McpManifest`, `Authorized`).
|
||||
5. Implement `init()` to register the tool.
|
||||
6. Add unit tests.
|
||||
|
||||
### Adding Documentation
|
||||
|
||||
- Add source documentation to `docs/en/resources/sources/`.
|
||||
- Add tool documentation to `docs/en/resources/tools/`.
|
||||
@@ -1,17 +0,0 @@
|
||||
cd server-darwin-arm64
|
||||
npm pack .
|
||||
npm publish --access public
|
||||
|
||||
cd ../server-darwin-x64
|
||||
npm pack .
|
||||
npm publish --access public
|
||||
|
||||
cd ../server-linux-x64
|
||||
npm pack .
|
||||
npm publish --access public
|
||||
|
||||
cd ../server-win32-x64
|
||||
npm pack .
|
||||
npm publish --access public
|
||||
|
||||
cd ..
|
||||
@@ -1,7 +0,0 @@
|
||||
cd server
|
||||
npm install --package-lock-only
|
||||
git add package.json package-lock.json
|
||||
git commit -m "update dep versions"
|
||||
|
||||
npm pack .
|
||||
npm publish --access public
|
||||
@@ -1,6 +0,0 @@
|
||||
# @toolbox-sdk/server-darwin-arm64
|
||||
|
||||
Platform-specific binary for the `toolbox` package on Darwin arm64.
|
||||
This package is automatically installed by the main `@toolbox-sdk/server` package and is not intended to be installed directly.
|
||||
|
||||
For more information, visit the [toolbox npm package](https://www.npmjs.com/package/@toolbox-sdk/server).
|
||||
19
packages/server-darwin-arm64/package-lock.json
generated
19
packages/server-darwin-arm64/package-lock.json
generated
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-darwin-arm64",
|
||||
"version": "0.27.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@toolbox-sdk/server-darwin-arm64",
|
||||
"version": "0.27.0",
|
||||
"cpu": [
|
||||
"arm64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"os": [
|
||||
"darwin"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-darwin-arm64",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"author": "Google LLC",
|
||||
"os": [
|
||||
"darwin"
|
||||
],
|
||||
"cpu": [
|
||||
"arm64"
|
||||
],
|
||||
"main": "bin/toolbox",
|
||||
"repository": "googleapis/genai-toolbox",
|
||||
"scripts": {
|
||||
"prepack": "node scripts/downloadBinary.js darwin arm64"
|
||||
},
|
||||
"files": [
|
||||
"bin/toolbox"
|
||||
]
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const https = require('https');
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
// 1. Configuration
|
||||
const PLATFORM_MAP = {
|
||||
'linux': 'linux',
|
||||
'darwin': 'darwin',
|
||||
'win32': 'windows'
|
||||
};
|
||||
|
||||
const ARCH_MAP = {
|
||||
'x64': 'amd64',
|
||||
'arm64': 'arm64'
|
||||
};
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
if (args.length < 2) {
|
||||
console.error("Usage: node download-binary.js <platform> <arch>");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const [targetPlatform, targetArch] = args;
|
||||
|
||||
// 2. Determine Version
|
||||
const version = fs.readFileSync(path.join(process.cwd(), 'version.txt'), 'utf8').trim();
|
||||
|
||||
// 3. Construct URL
|
||||
const gcsPlatform = PLATFORM_MAP[targetPlatform];
|
||||
const gcsArch = ARCH_MAP[targetArch];
|
||||
|
||||
if (!gcsPlatform || !gcsArch) {
|
||||
console.error(`Unsupported platform/arch: ${targetPlatform}/${targetArch}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const extension = targetPlatform === 'win32' ? '.exe' : '';
|
||||
const binaryName = `toolbox${extension}`;
|
||||
const url = `https://storage.googleapis.com/genai-toolbox/v${version}/${gcsPlatform}/${gcsArch}/${binaryName}`;
|
||||
|
||||
// 4. Prepare Output
|
||||
const binDir = path.join(process.cwd(), 'bin');
|
||||
if (!fs.existsSync(binDir)) {
|
||||
fs.mkdirSync(binDir, { recursive: true });
|
||||
}
|
||||
const destPath = path.join(binDir, binaryName);
|
||||
|
||||
if (fs.existsSync(destPath)) {
|
||||
console.log(`[Skipped] Binary already exists at ${destPath}`);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
console.log(`[Prepack] Downloading ${binaryName} for ${targetPlatform}/${targetArch}...`);
|
||||
console.log(`[Source] ${url}`);
|
||||
|
||||
// 5. Download Function
|
||||
const file = fs.createWriteStream(destPath);
|
||||
https.get(url, function(response) {
|
||||
if (response.statusCode !== 200) {
|
||||
console.error(`❌ Failed to download. Status Code: ${response.statusCode}`);
|
||||
fs.unlink(destPath, () => {}); // Delete partial file
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
response.pipe(file);
|
||||
|
||||
file.on('finish', () => {
|
||||
file.close(() => {
|
||||
// 6. Make executable (Unix only)
|
||||
if (targetPlatform !== 'win32') {
|
||||
try {
|
||||
execSync(`chmod +x "${destPath}"`);
|
||||
} catch (err) {
|
||||
console.warn("⚠️ Could not set executable permissions (chmod failed).");
|
||||
}
|
||||
}
|
||||
console.log(`✅ Success! Binary saved to ${destPath}`);
|
||||
});
|
||||
});
|
||||
}).on('error', function(err) {
|
||||
fs.unlink(destPath, () => {});
|
||||
console.error(`❌ Download Error: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -1 +0,0 @@
|
||||
0.27.0
|
||||
@@ -1,6 +0,0 @@
|
||||
# @toolbox-sdk/server-darwin-x64
|
||||
|
||||
Platform-specific binary for the `toolbox` package on Darwin x64.
|
||||
This package is automatically installed by the main `@toolbox-sdk/server` package and is not intended to be installed directly.
|
||||
|
||||
For more information, visit the [toolbox npm package](https://www.npmjs.com/package/@toolbox-sdk/server).
|
||||
19
packages/server-darwin-x64/package-lock.json
generated
19
packages/server-darwin-x64/package-lock.json
generated
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-darwin-x64",
|
||||
"version": "0.27.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@toolbox-sdk/server-darwin-x64",
|
||||
"version": "0.27.0",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"os": [
|
||||
"darwin"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-darwin-x64",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"author": "Google LLC",
|
||||
"os": [
|
||||
"darwin"
|
||||
],
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"main": "bin/toolbox",
|
||||
"repository": "googleapis/genai-toolbox",
|
||||
"scripts": {
|
||||
"prepack": "node scripts/downloadBinary.js darwin x64"
|
||||
},
|
||||
"files": [
|
||||
"bin/toolbox"
|
||||
]
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const https = require('https');
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
// 1. Configuration
|
||||
const PLATFORM_MAP = {
|
||||
'linux': 'linux',
|
||||
'darwin': 'darwin',
|
||||
'win32': 'windows'
|
||||
};
|
||||
|
||||
const ARCH_MAP = {
|
||||
'x64': 'amd64',
|
||||
'arm64': 'arm64'
|
||||
};
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
if (args.length < 2) {
|
||||
console.error("Usage: node download-binary.js <platform> <arch>");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const [targetPlatform, targetArch] = args;
|
||||
|
||||
// 2. Determine Version
|
||||
const version = fs.readFileSync(path.join(process.cwd(), 'version.txt'), 'utf8').trim();
|
||||
|
||||
// 3. Construct URL
|
||||
const gcsPlatform = PLATFORM_MAP[targetPlatform];
|
||||
const gcsArch = ARCH_MAP[targetArch];
|
||||
|
||||
if (!gcsPlatform || !gcsArch) {
|
||||
console.error(`Unsupported platform/arch: ${targetPlatform}/${targetArch}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const extension = targetPlatform === 'win32' ? '.exe' : '';
|
||||
const binaryName = `toolbox${extension}`;
|
||||
const url = `https://storage.googleapis.com/genai-toolbox/v${version}/${gcsPlatform}/${gcsArch}/${binaryName}`;
|
||||
|
||||
// 4. Prepare Output
|
||||
const binDir = path.join(process.cwd(), 'bin');
|
||||
if (!fs.existsSync(binDir)) {
|
||||
fs.mkdirSync(binDir, { recursive: true });
|
||||
}
|
||||
const destPath = path.join(binDir, binaryName);
|
||||
|
||||
if (fs.existsSync(destPath)) {
|
||||
console.log(`[Skipped] Binary already exists at ${destPath}`);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
console.log(`[Prepack] Downloading ${binaryName} for ${targetPlatform}/${targetArch}...`);
|
||||
console.log(`[Source] ${url}`);
|
||||
|
||||
// 5. Download Function
|
||||
const file = fs.createWriteStream(destPath);
|
||||
https.get(url, function(response) {
|
||||
if (response.statusCode !== 200) {
|
||||
console.error(`❌ Failed to download. Status Code: ${response.statusCode}`);
|
||||
fs.unlink(destPath, () => {}); // Delete partial file
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
response.pipe(file);
|
||||
|
||||
file.on('finish', () => {
|
||||
file.close(() => {
|
||||
// 6. Make executable (Unix only)
|
||||
if (targetPlatform !== 'win32') {
|
||||
try {
|
||||
execSync(`chmod +x "${destPath}"`);
|
||||
} catch (err) {
|
||||
console.warn("⚠️ Could not set executable permissions (chmod failed).");
|
||||
}
|
||||
}
|
||||
console.log(`✅ Success! Binary saved to ${destPath}`);
|
||||
});
|
||||
});
|
||||
}).on('error', function(err) {
|
||||
fs.unlink(destPath, () => {});
|
||||
console.error(`❌ Download Error: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -1 +0,0 @@
|
||||
0.27.0
|
||||
@@ -1,7 +0,0 @@
|
||||
# @toolbox-sdk/server-linux-x64
|
||||
|
||||
Platform-specific binary for the `toolbox` package on Linux x64.
|
||||
This package is automatically installed by the main `@toolbox-sdk/server` package and is not intended to be installed directly.
|
||||
|
||||
For more information, visit the [toolbox npm package](https://www.npmjs.com/package/@toolbox-sdk/server).
|
||||
|
||||
19
packages/server-linux-x64/package-lock.json
generated
19
packages/server-linux-x64/package-lock.json
generated
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-linux-x64",
|
||||
"version": "0.27.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@toolbox-sdk/server-linux-x64",
|
||||
"version": "0.27.0",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"os": [
|
||||
"linux"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-linux-x64",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"author": "Google LLC",
|
||||
"os": [
|
||||
"linux"
|
||||
],
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"main": "bin/toolbox",
|
||||
"repository": "googleapis/genai-toolbox",
|
||||
"scripts": {
|
||||
"prepack": "node scripts/downloadBinary.js linux x64"
|
||||
},
|
||||
"files": [
|
||||
"bin/toolbox"
|
||||
]
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const https = require('https');
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
// 1. Configuration
|
||||
const PLATFORM_MAP = {
|
||||
'linux': 'linux',
|
||||
'darwin': 'darwin',
|
||||
'win32': 'windows'
|
||||
};
|
||||
|
||||
const ARCH_MAP = {
|
||||
'x64': 'amd64',
|
||||
'arm64': 'arm64'
|
||||
};
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
if (args.length < 2) {
|
||||
console.error("Usage: node download-binary.js <platform> <arch>");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const [targetPlatform, targetArch] = args;
|
||||
|
||||
// 2. Determine Version
|
||||
const version = fs.readFileSync(path.join(process.cwd(), 'version.txt'), 'utf8').trim();
|
||||
|
||||
// 3. Construct URL
|
||||
const gcsPlatform = PLATFORM_MAP[targetPlatform];
|
||||
const gcsArch = ARCH_MAP[targetArch];
|
||||
|
||||
if (!gcsPlatform || !gcsArch) {
|
||||
console.error(`Unsupported platform/arch: ${targetPlatform}/${targetArch}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const extension = targetPlatform === 'win32' ? '.exe' : '';
|
||||
const binaryName = `toolbox${extension}`;
|
||||
const url = `https://storage.googleapis.com/genai-toolbox/v${version}/${gcsPlatform}/${gcsArch}/${binaryName}`;
|
||||
|
||||
// 4. Prepare Output
|
||||
const binDir = path.join(process.cwd(), 'bin');
|
||||
if (!fs.existsSync(binDir)) {
|
||||
fs.mkdirSync(binDir, { recursive: true });
|
||||
}
|
||||
const destPath = path.join(binDir, binaryName);
|
||||
|
||||
if (fs.existsSync(destPath)) {
|
||||
console.log(`[Skipped] Binary already exists at ${destPath}`);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
console.log(`[Prepack] Downloading ${binaryName} for ${targetPlatform}/${targetArch}...`);
|
||||
console.log(`[Source] ${url}`);
|
||||
|
||||
// 5. Download Function
|
||||
const file = fs.createWriteStream(destPath);
|
||||
https.get(url, function(response) {
|
||||
if (response.statusCode !== 200) {
|
||||
console.error(`❌ Failed to download. Status Code: ${response.statusCode}`);
|
||||
fs.unlink(destPath, () => {}); // Delete partial file
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
response.pipe(file);
|
||||
|
||||
file.on('finish', () => {
|
||||
file.close(() => {
|
||||
// 6. Make executable (Unix only)
|
||||
if (targetPlatform !== 'win32') {
|
||||
try {
|
||||
execSync(`chmod +x "${destPath}"`);
|
||||
} catch (err) {
|
||||
console.warn("⚠️ Could not set executable permissions (chmod failed).");
|
||||
}
|
||||
}
|
||||
console.log(`✅ Success! Binary saved to ${destPath}`);
|
||||
});
|
||||
});
|
||||
}).on('error', function(err) {
|
||||
fs.unlink(destPath, () => {});
|
||||
console.error(`❌ Download Error: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -1 +0,0 @@
|
||||
0.27.0
|
||||
@@ -1,7 +0,0 @@
|
||||
# @toolbox-sdk/server-win32-x64
|
||||
|
||||
Platform-specific binary for the `toolbox` package on Windows x64.
|
||||
This package is automatically installed by the main `@toolbox-sdk/server` package and is not intended to be installed directly.
|
||||
|
||||
For more information, visit the [toolbox npm package](https://www.npmjs.com/package/@toolbox-sdk/server).
|
||||
|
||||
19
packages/server-win32-x64/package-lock.json
generated
19
packages/server-win32-x64/package-lock.json
generated
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-win32-x64",
|
||||
"version": "0.27.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@toolbox-sdk/server-win32-x64",
|
||||
"version": "0.27.0",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"os": [
|
||||
"win32"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server-win32-x64",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"author": "Google LLC",
|
||||
"os": [
|
||||
"win32"
|
||||
],
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"main": "bin/toolbox.exe",
|
||||
"repository": "googleapis/genai-toolbox",
|
||||
"scripts": {
|
||||
"prepack": "node scripts/downloadBinary.js win32 x64"
|
||||
},
|
||||
"files": [
|
||||
"bin/toolbox.exe"
|
||||
]
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const https = require('https');
|
||||
const { execSync } = require('child_process');
|
||||
|
||||
// 1. Configuration
|
||||
const PLATFORM_MAP = {
|
||||
'linux': 'linux',
|
||||
'darwin': 'darwin',
|
||||
'win32': 'windows'
|
||||
};
|
||||
|
||||
const ARCH_MAP = {
|
||||
'x64': 'amd64',
|
||||
'arm64': 'arm64'
|
||||
};
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
if (args.length < 2) {
|
||||
console.error("Usage: node download-binary.js <platform> <arch>");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const [targetPlatform, targetArch] = args;
|
||||
|
||||
// 2. Determine Version
|
||||
const version = fs.readFileSync(path.join(process.cwd(), 'version.txt'), 'utf8').trim();
|
||||
|
||||
// 3. Construct URL
|
||||
const gcsPlatform = PLATFORM_MAP[targetPlatform];
|
||||
const gcsArch = ARCH_MAP[targetArch];
|
||||
|
||||
if (!gcsPlatform || !gcsArch) {
|
||||
console.error(`Unsupported platform/arch: ${targetPlatform}/${targetArch}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const extension = targetPlatform === 'win32' ? '.exe' : '';
|
||||
const binaryName = `toolbox${extension}`;
|
||||
const url = `https://storage.googleapis.com/genai-toolbox/v${version}/${gcsPlatform}/${gcsArch}/${binaryName}`;
|
||||
|
||||
// 4. Prepare Output
|
||||
const binDir = path.join(process.cwd(), 'bin');
|
||||
if (!fs.existsSync(binDir)) {
|
||||
fs.mkdirSync(binDir, { recursive: true });
|
||||
}
|
||||
const destPath = path.join(binDir, binaryName);
|
||||
|
||||
if (fs.existsSync(destPath)) {
|
||||
console.log(`[Skipped] Binary already exists at ${destPath}`);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
console.log(`[Prepack] Downloading ${binaryName} for ${targetPlatform}/${targetArch}...`);
|
||||
console.log(`[Source] ${url}`);
|
||||
|
||||
// 5. Download Function
|
||||
const file = fs.createWriteStream(destPath);
|
||||
https.get(url, function(response) {
|
||||
if (response.statusCode !== 200) {
|
||||
console.error(`❌ Failed to download. Status Code: ${response.statusCode}`);
|
||||
fs.unlink(destPath, () => {}); // Delete partial file
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
response.pipe(file);
|
||||
|
||||
file.on('finish', () => {
|
||||
file.close(() => {
|
||||
// 6. Make executable (Unix only)
|
||||
if (targetPlatform !== 'win32') {
|
||||
try {
|
||||
execSync(`chmod +x "${destPath}"`);
|
||||
} catch (err) {
|
||||
console.warn("⚠️ Could not set executable permissions (chmod failed).");
|
||||
}
|
||||
}
|
||||
console.log(`✅ Success! Binary saved to ${destPath}`);
|
||||
});
|
||||
});
|
||||
}).on('error', function(err) {
|
||||
fs.unlink(destPath, () => {});
|
||||
console.error(`❌ Download Error: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -1 +0,0 @@
|
||||
0.27.0
|
||||
@@ -1,69 +0,0 @@
|
||||
# Toolbox
|
||||
|
||||
A CLI tool for running a toolbox server.
|
||||
|
||||
## Installation
|
||||
|
||||
You can install the toolbox globally:
|
||||
|
||||
```bash
|
||||
npm install -g @toolbox-sdk/server
|
||||
```
|
||||
|
||||
Or run it directly using npx:
|
||||
|
||||
```bash
|
||||
npx @toolbox-sdk/server
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The toolbox requires a `tools.yaml` file in the current working directory to define sources, tools, and prompts.
|
||||
|
||||
### Example `tools.yaml`
|
||||
|
||||
```yaml
|
||||
sources:
|
||||
my-pg-source:
|
||||
kind: postgres
|
||||
host: 127.0.0.1
|
||||
port: 5432
|
||||
database: toolbox_db
|
||||
user: postgres
|
||||
password: password
|
||||
tools:
|
||||
search-hotels-by-name:
|
||||
kind: postgres-sql
|
||||
source: my-pg-source
|
||||
description: Search for hotels based on name.
|
||||
parameters:
|
||||
- name: name
|
||||
type: string
|
||||
description: The name of the hotel.
|
||||
statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';
|
||||
prompts:
|
||||
code-review:
|
||||
description: "Asks the LLM to analyze code quality and suggest improvements."
|
||||
messages:
|
||||
- role: "user"
|
||||
content: "Please review the following code for quality, correctness, and potential improvements: \n\n{{.code}}"
|
||||
arguments:
|
||||
- name: "code"
|
||||
description: "The code to review"
|
||||
required: true
|
||||
```
|
||||
|
||||
To learn more on how to configure your toolbox, visit the [official docsite](https://googleapis.github.io/genai-toolbox/getting-started/configure/).
|
||||
|
||||
## Platform Support
|
||||
|
||||
The toolbox automatically handles platform-specific binaries. Supported platforms include:
|
||||
- macOS (arm64, x64)
|
||||
- Linux (x64)
|
||||
- Windows (x64)
|
||||
|
||||
## Resources
|
||||
|
||||
For more information, visit the
|
||||
- [MCP Toolbox repository](https://github.com/googleapis/genai-toolbox)
|
||||
- [Official Documentation](https://googleapis.github.io/genai-toolbox/getting-started/introduction/)
|
||||
@@ -1,49 +0,0 @@
|
||||
#!/usr/bin/env node
|
||||
const { spawn } = require('child_process');
|
||||
const path = require('path');
|
||||
const os = require('os');
|
||||
const fs = require('fs');
|
||||
|
||||
const PLATFORMS = {
|
||||
'darwin-arm64': '@toolbox-sdk/server-darwin-arm64',
|
||||
'darwin-x64': '@toolbox-sdk/server-darwin-x64',
|
||||
'linux-x64': '@toolbox-sdk/server-linux-x64',
|
||||
'win32-x64': '@toolbox-sdk/server-win32-x64'
|
||||
};
|
||||
|
||||
const currentKey = `${os.platform()}-${os.arch()}`;
|
||||
const pkgName = PLATFORMS[currentKey];
|
||||
|
||||
if (!pkgName) {
|
||||
console.error(`Unsupported platform: ${currentKey}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
let binPath;
|
||||
try {
|
||||
const pkgJsonPath = require.resolve(`${pkgName}/package.json`);
|
||||
const pkgDir = path.dirname(pkgJsonPath);
|
||||
const binName = os.platform() === 'win32' ? 'toolbox.exe' : 'toolbox';
|
||||
binPath = path.join(pkgDir, 'bin', binName);
|
||||
} catch (e) {
|
||||
console.error(`Binary for ${currentKey} not found. Installation failed?`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (os.platform() !== 'win32') {
|
||||
try {
|
||||
fs.chmodSync(binPath, 0o755);
|
||||
if (os.platform() === 'darwin') {
|
||||
const { execSync } = require('child_process');
|
||||
try {
|
||||
execSync(`xattr -d com.apple.quarantine "${binPath}"`, { stdio: 'ignore' });
|
||||
} catch (e) {
|
||||
}
|
||||
}
|
||||
} catch (e) {
|
||||
console.warn(`Could not set execute permissions on ${binPath}: ${e.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
spawn(binPath, process.argv.slice(2), { stdio: 'inherit' })
|
||||
.on('exit', process.exit);
|
||||
74
packages/server/package-lock.json
generated
74
packages/server/package-lock.json
generated
@@ -1,74 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server",
|
||||
"version": "0.27.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@toolbox-sdk/server",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"bin": {
|
||||
"toolbox": "bin/run.js"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"@toolbox-sdk/server-darwin-arm64": "0.27.0",
|
||||
"@toolbox-sdk/server-darwin-x64": "0.27.0",
|
||||
"@toolbox-sdk/server-linux-x64": "0.27.0",
|
||||
"@toolbox-sdk/server-win32-x64": "0.27.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@toolbox-sdk/server-darwin-arm64": {
|
||||
"version": "0.27.0",
|
||||
"resolved": "https://registry.npmjs.org/@toolbox-sdk/server-darwin-arm64/-/server-darwin-arm64-0.27.0.tgz",
|
||||
"integrity": "sha512-qGP7t4JCS9TgQTySA7WnFbrebc9CgZNfQUdlmHdCVw1ZbH+xE5eABalLkeMvDJUmevpTy51G3osxRyh3eVDCnQ==",
|
||||
"cpu": [
|
||||
"arm64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"optional": true,
|
||||
"os": [
|
||||
"darwin"
|
||||
]
|
||||
},
|
||||
"node_modules/@toolbox-sdk/server-darwin-x64": {
|
||||
"version": "0.27.0",
|
||||
"resolved": "https://registry.npmjs.org/@toolbox-sdk/server-darwin-x64/-/server-darwin-x64-0.27.0.tgz",
|
||||
"integrity": "sha512-ZdHHSbJRt4YmKteuFXRQzixpzHz3q5xqQFv1KUQlLDpjIw8duOTFoA22EZtDssSh74oxVlU/X5yWPT9ED59W2g==",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"optional": true,
|
||||
"os": [
|
||||
"darwin"
|
||||
]
|
||||
},
|
||||
"node_modules/@toolbox-sdk/server-linux-x64": {
|
||||
"version": "0.27.0",
|
||||
"resolved": "https://registry.npmjs.org/@toolbox-sdk/server-linux-x64/-/server-linux-x64-0.27.0.tgz",
|
||||
"integrity": "sha512-XJoUBIFoi02KQuiv7X8XP/eZAigk3sPnfBCtQVZ8zIl5NdbxGKyIYMUj0I8aYwpSk/8pAzow4YqryiIWeMP9aA==",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"optional": true,
|
||||
"os": [
|
||||
"linux"
|
||||
]
|
||||
},
|
||||
"node_modules/@toolbox-sdk/server-win32-x64": {
|
||||
"version": "0.27.0",
|
||||
"resolved": "https://registry.npmjs.org/@toolbox-sdk/server-win32-x64/-/server-win32-x64-0.27.0.tgz",
|
||||
"integrity": "sha512-xedHjbIRtpxn/x64D8Us8APEGuiXTqABWsQfubcDr4KOD+pnH1vyBZbiCgXRFIEKAeUSYVEMgDPxwUTV6TOlKg==",
|
||||
"cpu": [
|
||||
"x64"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"optional": true,
|
||||
"os": [
|
||||
"win32"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"name": "@toolbox-sdk/server",
|
||||
"version": "0.27.0",
|
||||
"license": "Apache-2.0",
|
||||
"author": "Google LLC",
|
||||
"bin": {
|
||||
"toolbox": "./bin/run.js"
|
||||
},
|
||||
"files": [
|
||||
"bin/run.js"
|
||||
],
|
||||
"repository": "googleapis/genai-toolbox",
|
||||
"optionalDependencies": {
|
||||
"@toolbox-sdk/server-darwin-arm64": "0.27.0",
|
||||
"@toolbox-sdk/server-darwin-x64": "0.27.0",
|
||||
"@toolbox-sdk/server-linux-x64": "0.27.0",
|
||||
"@toolbox-sdk/server-win32-x64": "0.27.0"
|
||||
}
|
||||
}
|
||||
@@ -1,91 +0,0 @@
|
||||
# How to test on different platforms
|
||||
|
||||
1. Create a local test registry. We are using Verdaccio. During the actual process, we publish to npm instead.
|
||||
```sh
|
||||
# install
|
||||
npm install -g verdaccio
|
||||
|
||||
# start server
|
||||
verdaccio
|
||||
```
|
||||
|
||||
The output will show the config file location and the URL. Open your browser to:
|
||||
http://localhost:4873
|
||||
|
||||
> Note: You can use `npm unpublish @toolbox-sdk/server --force --registry http://localhost:4873` to unpublish the package.
|
||||
|
||||
2. Pack all 4 packages and publish them to the local registry. Go in each package (eg. server-darwin-arm64) and run
|
||||
```sh
|
||||
npm ci --force
|
||||
npm pack .
|
||||
```
|
||||
|
||||
Then publish to the local registry
|
||||
```sh
|
||||
npm publish --registry http://localhost:4873
|
||||
```
|
||||
|
||||
3. Go to the server package and run
|
||||
```sh
|
||||
npm ci --force
|
||||
npm pack .
|
||||
npm publish --registry http://localhost:4873
|
||||
```
|
||||
|
||||
Now, you have published your package.
|
||||
|
||||
4. Now create a new folder (let's call it testing.) Add a tools.yaml file to the folder. It should look like this:
|
||||
```yaml
|
||||
sources:
|
||||
my-pg-source:
|
||||
kind: postgres
|
||||
host: 127.0.0.1
|
||||
port: 5432
|
||||
database: toolbox_db
|
||||
user: postgres
|
||||
password: password
|
||||
tools:
|
||||
search-hotels-by-name:
|
||||
kind: postgres-sql
|
||||
source: my-pg-source
|
||||
description: Search for hotels based on name.
|
||||
parameters:
|
||||
- name: name
|
||||
type: string
|
||||
description: The name of the hotel.
|
||||
statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';
|
||||
prompts:
|
||||
code-review:
|
||||
description: "Asks the LLM to analyze code quality and suggest improvements."
|
||||
messages:
|
||||
- role: "user"
|
||||
content: "Please review the following code for quality, correctness, and potential improvements: \n\n{{.code}}"
|
||||
arguments:
|
||||
- name: "code"
|
||||
description: "The code to review"
|
||||
required: true
|
||||
```
|
||||
|
||||
Note: Do not test this directly to the server folder. The registry might pick up local packages instead of global installation.
|
||||
Use a separate testing folder outside the server folder for this testing.
|
||||
|
||||
6. From the testing folder, run
|
||||
```sh
|
||||
npx --registry=http://localhost:4873/ -y @toolbox-sdk/server
|
||||
```
|
||||
|
||||
This should start up the toolbox server with the tools.yaml file.
|
||||
|
||||
7. Run the command to verify that the tools are available:
|
||||
|
||||
```sh
|
||||
curl --location 'http://127.0.0.1:5000/mcp' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"jsonrpc": "2.0",
|
||||
"method": "tools/list",
|
||||
"params": {},
|
||||
"id": 1
|
||||
}'
|
||||
|
||||
```
|
||||
@@ -1,23 +0,0 @@
|
||||
cd server-darwin-arm64
|
||||
npm install --force
|
||||
rm -rf bin/
|
||||
git add version.txt package.json package-lock.json
|
||||
|
||||
cd ../server-darwin-x64
|
||||
npm install --force
|
||||
rm -rf bin/
|
||||
git add version.txt package.json package-lock.json
|
||||
|
||||
|
||||
cd ../server-linux-x64
|
||||
npm install --force
|
||||
rm -rf bin/
|
||||
git add version.txt package.json package-lock.json
|
||||
|
||||
|
||||
cd ../server-win32-x64
|
||||
npm install --force
|
||||
rm -rf bin/
|
||||
git add version.txt package.json package-lock.json
|
||||
|
||||
cd ..
|
||||
Reference in New Issue
Block a user