Skip to content

Add 'uvx' entry point for simplified MCP configuration #1

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

Add 'uvx' entry point for simplified MCP configuration #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,9 @@ You can easily integrate Code Index MCP with Claude Desktop:
{
"mcpServers": {
"code-indexer": {
"command": "uv",
"command": "uvx",
"args": [
"--directory",
"C:\\Users\\username\\path\\to\\code-index-mcp",
"run",
"run.py"
"C:\\Users\\username\\path\\to\\code-index-mcp"
]
}
}
Expand All @@ -77,19 +74,17 @@ You can easily integrate Code Index MCP with Claude Desktop:
{
"mcpServers": {
"code-indexer": {
"command": "uv",
"command": "uvx",
"args": [
"--directory",
"/home/username/path/to/code-index-mcp",
"run",
"run.py"
"/Users/username/path/to/code-index-mcp"
]
}
}
}
```

**Note**: The `--directory` option is important as it ensures uv runs in the correct project directory and can properly load all dependencies.
**Note**: The tool can also be run directly with `uv run run.py` which may be useful for development and debugging.

4. Restart Claude Desktop to use Code Indexer for analyzing code projects

No manual dependency installation is required - UV will automatically handle all dependencies when running the server.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Homepage = "https://github.com/yourusername/code-index-mcp"

[project.scripts]
code-indexer = "code_index_mcp.server:main"
uvx = "code_index_mcp.server:main"

[tool.setuptools]
package-dir = {"" = "src"}