Skip to content

Comments

Add uvx as recommended installation-free method for MCP server#58

Merged
harumiWeb merged 2 commits intomainfrom
copilot/add-uvx-documentation
Feb 17, 2026
Merged

Add uvx as recommended installation-free method for MCP server#58
harumiWeb merged 2 commits intomainfrom
copilot/add-uvx-documentation

Conversation

Copy link
Contributor

Copilot AI commented Feb 17, 2026

Adds uvx documentation as the recommended method for running ExStruct MCP server, eliminating the need for pip install while providing automatic dependency management and environment isolation.

Changes

README files (README.md, docs/README.en.md, README.ja.md)

  • Restructured MCP Server section with uvx as primary method
  • Moved pip installation to "Traditional Installation" subsection
  • Added benefit callouts: no pip install, auto dependency management, environment isolation, version pinning

MCP documentation (docs/mcp.md)

  • Expanded Installation section with three options:
    • Option 1: uvx (recommended) - direct execution without install
    • Option 2: pip install - traditional method
    • Option 3: Git URL - development version via uvx
  • Added uvx configuration examples for AI agents:
    • Claude Desktop / GitHub Copilot (JSON config)
    • Codex (TOML config)
  • Retained pip-based configurations for reference

Usage comparison

Before (pip install required):

pip install exstruct[mcp]
exstruct-mcp --root C:\data

After (no install):

uvx --from 'exstruct[mcp]' exstruct-mcp --root C:\data

Agent config (uvx):

{
  "mcpServers": {
    "exstruct": {
      "command": "uvx",
      "args": ["--from", "exstruct[mcp]", "exstruct-mcp", "--root", "C:\\data"]
    }
  }
}
Original prompt

Overview

Add documentation for using uvx to run the ExStruct MCP server directly without requiring pip install. This provides users with a simpler, more modern installation-free option.

Files to Update

1. README.md - MCP Server section (around lines 64-89)

Update the MCP Server section to include uvx as the recommended method:

Current content:

## MCP Server (stdio)

Install the MCP extras and run the stdio server:

```bash
pip install exstruct[mcp]
exstruct-mcp --root C:\data --log-file C:\logs\exstruct-mcp.log --on-conflict rename

**Update to:**
````markdown
## MCP Server (stdio)

### Quick Start with uvx (recommended)

Run directly without installation:

```bash
uvx --from 'exstruct[mcp]' exstruct-mcp --root C:\data --log-file C:\logs\exstruct-mcp.log --on-conflict rename

Benefits:

  • No pip install required
  • Automatic dependency management
  • Environment isolation
  • Easy version pinning: uvx --from 'exstruct[mcp]==0.4.4' exstruct-mcp

Traditional Installation

Alternatively, install with pip:

pip install exstruct[mcp]
exstruct-mcp --root C:\data --log-file C:\logs\exstruct-mcp.log --on-conflict rename

### 2. `docs/README.en.md` - Same MCP Server section
Apply the same changes as README.md to maintain consistency.

### 3. `docs/mcp.md` - Installation and Configuration sections

**Update the Installation section (lines 14-16):**

Current:
```markdown
## Installation

```bash
pip install exstruct[mcp]
```
```

Update to:
````markdown
## Installation

### Option 1: Using uvx (recommended)

No installation required! Run directly with uvx:

```bash
uvx --from 'exstruct[mcp]' exstruct-mcp --root C:\data
```

Benefits:
- No `pip install` needed
- Automatic dependency management  
- Environment isolation
- Easy version pinning: `uvx --from 'exstruct[mcp]==0.4.4' exstruct-mcp`

### Option 2: Traditional pip install

```bash
pip install exstruct[mcp]
```

### Option 3: Development version from Git

```bash
uvx --from 'exstruct[mcp] @ git+https://github.com/harumiWeb/exstruct.git@main' exstruct-mcp --root .
```

**Note:** When using Git URLs, the `[mcp]` extra must be explicitly included in the dependency specification.

Update AI agent configuration examples (around lines 179-211):

Add uvx examples before the current examples:

## AI agent configuration examples

### Using uvx (recommended)

#### Claude Desktop / GitHub Copilot

```json
{
  "mcpServers": {
    "exstruct": {
      "command": "uvx",
      "args": [
        "--from",
        "exstruct[mcp]",
        "exstruct-mcp",
        "--root",
        "C:\\data",
        "--log-file",
        "C:\\logs\\exstruct-mcp.log",
        "--on-conflict",
        "rename"
      ]
    }
  }
}

Codex

[mcp_servers.exstruct]
command = "uvx"
args = [
  "--from",
  "exstruct[mcp]",
  "exstruct-mcp",
  "--root",
  "C:\\data",
  "--log-file",
  "C:\\logs\\exstruct-mcp.log",
  "--on-conflict",
  "rename"
]

Using pip install

Codex

~/.codex/config.toml

[mcp_servers.exstruct]
command = "exstruct-mcp"
args = ["--root", "C:\\data", "--log-file", "C:\\logs\\exstruct-mcp.log", "--on-conflict", "rename"]

GitHub Copilot / Claude Desktop / Gemini CLI

Register an MCP server with a command + args in your MCP settings:

{
  "mcpServers": {
    "exstruct": {
      "command": "exstruct-mcp",
      "args": ["--root", "C:\\data"]
    }
  }
}

### 4. `README.ja.md` - Japanese version

Update the MCP section (around lines 63-78) with Japanese documentation:

````markdown
## MCP サーバー (stdio)

### uvx を使ったクイックスタート(推奨)

インストール不要で直接実行できます:

```bash
uvx --from 'exstruct[mcp]' exstruct-mcp --root C:\data --log-file C:\logs\exstruct-mcp.log --on-conflict rename

利点:

  • pip install が不要
  • 依存関係の自動管理
  • 環境の分離
  • バージョン指定が簡単: uvx --from 'exstruct[mcp]==0.4.4' exstruct-mcp

従来のインストール方法

pip でインストールすることもできます:

pip install exstruct[mcp]
exstruct-mcp --root C:\data --log-file C:\logs\exstruct-mcp.log --on-conflict rename

## Requirements

- Maintain existing formatting and style
- Keep all existing content and examples
- Add new uvx examples as the recommended method
- Keep traditional pip install method as an alternative
- Ensure consistency across all documentation files (README.md, README.ja.md, docs/README.en.md, docs/mcp.md)
- Update MCP configuration examples to show both uvx and pip approaches

This pull request was created from Copilot chat.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@codacy-production
Copy link

codacy-production bot commented Feb 17, 2026

Codacy's Analysis Summary

0 new issue (≤ 0 issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

Co-authored-by: harumiWeb <164025931+harumiWeb@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for using uvx with ExStruct MCP server Add uvx as recommended installation-free method for MCP server Feb 17, 2026
Copilot AI requested a review from harumiWeb February 17, 2026 13:56
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@harumiWeb harumiWeb marked this pull request as ready for review February 17, 2026 13:59
@harumiWeb harumiWeb merged commit 9878da8 into main Feb 17, 2026
8 checks passed
@harumiWeb harumiWeb deleted the copilot/add-uvx-documentation branch February 17, 2026 14:00
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b5aac00862

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +16 to +18
### Option 1: Using uvx (recommended)

No installation required! Run directly with uvx:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Align start instructions with uvx-recommended install path

This section now marks uvx as the recommended, no-installation path, but the later Start (stdio) command still uses bare exstruct-mcp, which is only available after a traditional install. Users who follow Option 1 verbatim can hit command not found when they continue to the start step, so the docs should either provide a uvx-based start command there or explicitly state that the current start command assumes pip install.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants