Skip to content

Commit 130c37e

Browse files
AWOrpingtonAWOrpington
authored
Merge pull request #20 from conductor-oss/awquickstart
chore: update readme with clearer instructions for getting started.
2 parents fa0ed3b + e9a7930 commit 130c37e

File tree

2 files changed

+60
-60
lines changed

2 files changed

+60
-60
lines changed

‎README.md‎

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -11,70 +11,26 @@ specific language governing permissions and limitations under the License.
1111
# oss-conductor-mcp
1212
Model Context Protocol server for Conductor.
1313

14-
# Running the server
15-
This project relies on `uv` https://docs.astral.sh/uv/getting-started/
14+
This package is used to run an MCP server that is capable of interacting with a Conductor instance. It provides tools
15+
for the basic operations that may be needed by an MCP client for Workflow creation, execution, and analysis.
1616

17-
Create venv (not entirely necessary, since `uv` automatically creates and uses the virtual environment on its own when running other commands)
18-
```commandline
19-
uv sync
20-
source .venv/bin/activate
21-
```
22-
Run Server
23-
```commandline
24-
uv run server.py
25-
```
26-
---
27-
For local development, a `local_development.py` file is provided for convenience for setting environment variables explicitly.
28-
29-
This is particularly useful where you don't have control over the environment, i.e. running in Claude.
30-
```
31-
os.environ[CONDUCTOR_SERVER_URL] = 'https://developer.orkescloud.com/api'
32-
os.environ[CONDUCTOR_AUTH_KEY] = '<YOUR_APPLICATION_AUTH_KEY>'
33-
os.environ[CONDUCTOR_AUTH_SECRET] = '<YOUR_APPLICATION_SECRET_KEY>'
34-
```
35-
To run with local development add '--local_dev' to the server arguments:
36-
```commandline
37-
uv run server.py --local_dev
38-
```
39-
> Note: the `/api` path is required as part of the CONDUCTOR_SERVER_URL for most applications
40-
# Adding to Claude
41-
Follow [this tutorial](https://modelcontextprotocol.io/quickstart/user) for adding the mcp server to claude, and use the following
42-
configuration, with or without the `--local_dev` argument:
43-
```json
44-
{
45-
"mcpServers": {
46-
"conductor": {
47-
"command": "uv",
48-
"args": [
49-
"--directory",
50-
"/<YOUR ABSOLUTE PATH TO THE DIRECTORY CONTAINING server.py>",
51-
"run",
52-
"server.py",
53-
"--local_dev"
54-
]
55-
}
56-
}
57-
}
58-
```
59-
After adding this configuration, Claude must be restarted to pick up the new MCP server.
60-
61-
> Note: alternatively you can use the absolute path to the project root and use 'conductor-mcp' instead of 'server.py'
62-
63-
## Global install
64-
If you installed the package globally, i.e. from pypi:
17+
# PyPi Quickstart
18+
## Install package
6519
```commandline
6620
pip install conductor-mcp
6721
```
68-
then you can point to the system install in your Claude config, but first you must create a json config file for your conductor values:
6922

23+
## Create a JSON config with your Conductor keys
7024
```json
7125
{
7226
"CONDUCTOR_SERVER_URL": "https://developer.orkescloud.com/api",
7327
"CONDUCTOR_AUTH_KEY": "<YOUR_APPLICATION_AUTH_KEY>",
7428
"CONDUCTOR_AUTH_SECRET": "<YOUR_APPLICATION_SECRET_KEY>"
7529
}
7630
```
77-
Claude config:
31+
> Note: the `/api` path is required as part of the CONDUCTOR_SERVER_URL for most applications
32+
33+
## Plug the server into an AI Agent, such as Claude or Cursor
7834
```json
7935
{
8036
"mcpServers": {
@@ -88,16 +44,60 @@ Claude config:
8844
}
8945
}
9046
```
47+
You should now be able to interact with Conductor via your AI Agent.
9148

92-
You can also start the server from the command line on its own after installing through pip:
93-
```commandline
94-
conductor-mcp --config YOUR_CONFIG_FILE
95-
```
96-
49+
### Adding to Claude
50+
You can find instructions for adding to Claude [here](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server).
51+
In general, you just add the `mcpServers` config (above) to your Claude config (or create it if it doesn't exist). For
52+
instance, on Mac it might be `~/Library/Application\ Support/Claude/claude_desktop_config.json`.
9753

98-
# Adding to Cursor
54+
### Adding to Cursor
9955
The main Cursor instructions are [here](https://docs.cursor.com/context/model-context-protocol).
10056
Go to `Cursor -> Settings -> Cursor Settings -> MCP` and select "+ Add new global MCP server".
10157

10258
Here you can add the exact same configuration file shown in the example for Claude (above).
103-
You can then access the AI chat feature and explore the MCP server in the [sidebar with ⌘+L (Mac) or Ctrl+L (Windows/Linux)](https://docs.cursor.com/chat/overview).
59+
You can then access the AI chat feature and explore the MCP server in the [sidebar with ⌘+L (Mac) or Ctrl+L (Windows/Linux)](https://docs.cursor.com/chat/overview).
60+
61+
## Example prompts
62+
### Get Flight Risk Info
63+
```text
64+
Create and execute a Conductor Workflow that calls any necessary http endpoints to gather current weather data around
65+
Seattle and outputs the risk factors for flying a small airplane around the South Lake Union area using Visual Flight
66+
Rules today. Only use publicly available endpoints that don't require an API key.
67+
```
68+
### Notify Stocks
69+
(May require API Keys)
70+
```text
71+
Create a Conductor Workflow that runs on a daily schedule, accepts a list of email address and a stock symbol, checks
72+
current stock prices, and sends an email to everyone on the list if they should be happy or sad today based on stock
73+
performance. Name the workflow "NotifyStonks" and use schemaVersion 2.
74+
```
75+
76+
# GitHub Quickstart
77+
## Clone GitHub Repo
78+
```commandline
79+
gh repo clone conductor-oss/conductor-mcp
80+
```
81+
82+
This project relies on `uv` https://docs.astral.sh/uv/getting-started/
83+
84+
## Create venv
85+
(not entirely necessary, since `uv` automatically creates and uses the virtual environment on its own when running other commands)
86+
```commandline
87+
uv sync
88+
source .venv/bin/activate
89+
```
90+
## Define Env Vars
91+
You can continue to use a JSON config file and the `--config` flag, or if the server is running in an environment where
92+
you have control over the environment variables the MCP server will look for them there if a config file is not
93+
provided.
94+
```commandline
95+
export CONDUCTOR_SERVER_URL="YOUR_CONDUCTOR_SERVER_URL"
96+
export CONDUCTOR_AUTH_KEY="<YOUR_APPLICATION_AUTH_KEY>"
97+
export CONDUCTOR_AUTH_SECRET="<YOUR_APPLICATION_SECRET_KEY>"
98+
```
99+
## Run Server
100+
```commandline
101+
uv run server.py
102+
```
103+
> Note: a `local_development.py` also exists for setting env vars and will be used when the `--local_dev` flag is set.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# specific language governing permissions and limitations under the License.
99
[project]
1010
name = "conductor-mcp"
11-
version = "0.1.5"
11+
version = "0.1.6"
1212
description = "MCP server for exposing conductor endpoints."
1313
readme = "README.md"
1414
requires-python = ">=3.13"

0 commit comments

Comments
 (0)