Skip to content

Deployment: Dockerfile and Smithery config #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM node:lts-alpine

WORKDIR /app

# Copy package files and install dependencies without running scripts
COPY package.json package-lock.json ./
RUN npm install --ignore-scripts

# Copy the rest of the source code
COPY . .

# Manually build the project
RUN npm run build

CMD ["npm", "start"]
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Salesforce CLI MCP Server

[![smithery badge](https://smithery.ai/badge/@codefriar/sf-mcp)](https://smithery.ai/server/@codefriar/sf-mcp)

Model Context Protocol (MCP) server for providing Salesforce CLI functionality to LLM tools like Claude Desktop.

## Overview
Expand All @@ -18,6 +20,15 @@ This MCP server wraps the Salesforce CLI (`sf`) command-line tool and exposes it

## Installation

### Installing via Smithery

To install Salesforce CLI MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@codefriar/sf-mcp):

```bash
npx -y @smithery/cli install @codefriar/sf-mcp --client claude
```

### Manual Installation
```bash
# Clone the repository
git clone <repository-url>
Expand Down
22 changes: 22 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
properties:
projectRoots:
type: array
items:
type: string
default: []
description: Optional list of Salesforce project directories to use as roots.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => { const args = ['build/index.js']; if (config.projectRoots && Array.isArray(config.projectRoots) && config.projectRoots.length > 0) { args.push(...config.projectRoots); } return { command: 'node', args }; }
exampleConfig:
projectRoots:
- /path/to/project1
- /path/to/project2