Skip to content

Commit 9ad2ed3

Browse files
authored
Merge pull request #21 from conductor-oss/awupdatereadme
chore: improve github quickstart instructions
2 parents 130c37e + 25b1db1 commit 9ad2ed3

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,27 @@ export CONDUCTOR_SERVER_URL="YOUR_CONDUCTOR_SERVER_URL"
9696
export CONDUCTOR_AUTH_KEY="<YOUR_APPLICATION_AUTH_KEY>"
9797
export CONDUCTOR_AUTH_SECRET="<YOUR_APPLICATION_SECRET_KEY>"
9898
```
99-
## Run Server
99+
## Configure Your AI Assistant
100+
```json
101+
{
102+
"mcpServers": {
103+
"conductor": {
104+
"command": "uv",
105+
"args": [
106+
"--directory",
107+
"<ABSOLUTE_PATH_TO_THE_PROJECT>",
108+
"run",
109+
"conductor-mcp",
110+
"--config",
111+
"<ABSOLUTE PATH TO A JSON CONFIG FILE>"
112+
]
113+
}
114+
}
115+
}
116+
```
117+
### Or Run Server Directly
100118
```commandline
101-
uv run server.py
119+
cd <PROJECT_ROOT>
120+
uv run conductor-mcp --config <ABSOLUTE PATH TO A JSON CONFIG FILE>
102121
```
103122
> Note: a `local_development.py` also exists for setting env vars and will be used when the `--local_dev` flag is set.

local_development.py

Lines changed: 0 additions & 20 deletions
This file was deleted.

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.6"
11+
version = "0.1.7"
1212
description = "MCP server for exposing conductor endpoints."
1313
readme = "README.md"
1414
requires-python = ">=3.13"

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)