Skip to content
Merged
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
18 changes: 17 additions & 1 deletion README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,23 @@ exstruct input.xlsx --pdf --image # PDF と PNG(Excel 必須)

## MCPサーバー (標準入出力)

MCPの拡張機能をインストールし、標準入出力サーバーを実行します。
### 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 でインストールすることもできます:

```bash
pip install exstruct[mcp]
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,23 @@ Auto page-break exports are available via API and CLI when Excel/COM is availabl

## MCP Server (stdio)

Install the MCP extras and run the stdio server:
### 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:

```bash
pip install exstruct[mcp]
Expand Down
18 changes: 17 additions & 1 deletion docs/README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,23 @@ Auto page-break exports are available via API and CLI when Excel/COM is availabl

## MCP Server (stdio)

Install the MCP extras and run the stdio server:
### 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:

```bash
pip install exstruct[mcp]
Expand Down
73 changes: 71 additions & 2 deletions docs/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,34 @@ so AI agents can call it safely as a tool.

## Installation

### Option 1: Using uvx (recommended)

No installation required! Run directly with uvx:
Comment on lines +16 to +18
Copy link
Copy Markdown

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 👍 / 👎.


```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.

## Start (stdio)

```bash
Expand Down Expand Up @@ -178,7 +202,52 @@ Examples:

## AI agent configuration examples

### Codex
### 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

```toml
[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`

Expand All @@ -188,7 +257,7 @@ command = "exstruct-mcp"
args = ["--root", "C:\\data", "--log-file", "C:\\logs\\exstruct-mcp.log", "--on-conflict", "rename"]
```

### GitHub Copilot / Claude Desktop / Gemini CLI
#### GitHub Copilot / Claude Desktop / Gemini CLI

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

Expand Down
Loading