Metadata-Version: 2.4
Name: openconstruction-tools
Version: 0.1.2
Summary: OpenConstruction MCP server, command-line interface, and shared catalog services.
Author: OpenConstruction
License-Expression: Apache-2.0
Project-URL: Homepage, https://www.openconstruction.org/mcp-cli.html
Project-URL: Documentation, https://www.openconstruction.org/mcp-cli.html
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: cryptography<51,>=50.0.2
Requires-Dist: certifi>=2026.10.18
Requires-Dist: filelock<5,>=4.2.11
Requires-Dist: fastapi<1,>=0.115
Requires-Dist: huggingface-hub<2,>=0.25
Requires-Dist: gdown<6,>=5.2.2
Requires-Dist: httpx<1,>=0.27
Requires-Dist: uvicorn<1,>=0.30
Dynamic: license-file

# OpenConstruction Tools

Find and compare construction datasets, models, and other AEC resources.
Use the CLI in your terminal or connect an MCP client.

## Install

Requires Python 3.11 or newer. Install the package from [PyPI](https://pypi.org/project/openconstruction-tools/):

```bash
pip install --upgrade openconstruction-tools
```

## Use the CLI

```bash
openconstruction search "hardhat" --type dataset
openconstruction show dataset CHVG
openconstruction download CHVG
```

The download command asks you to review the dataset license and confirm.
Files are saved under `~/.openconstruction/datasets`. For scripts, review the
terms first, then pass `--accept-license`. Run `openconstruction --help`
for more commands.

Local MCP and CLI download public Hugging Face datasets and Google Drive files
and folders directly from catalog source links, as well as Zenodo, Figshare,
declared HTTP files, and catalog-declared GitHub repositories. Hugging Face
revision, file, and subfolder selections are preserved. Gated Hugging Face
datasets require provider approval and local `hf auth login`. Private Drive
shares require Google's own access workflow. Provider credentials remain local.

Hosted MCP returns public Hugging Face file links pinned to a commit. Google
Drive transfers use local MCP or `openconstruction download DATASET_ID`; hosted
MCP returns that command and the source link. See [provider support](docs/usage.md#supported-sources-and-storage).

## Connect MCP

For the hosted service, add this HTTP endpoint to your MCP client and sign in
to OpenConstruction when prompted. No Python installation is needed:

```text
https://mcp.openconstruction.org/mcp
```

For Codex, register the hosted server and authenticate:

```bash
codex mcp add openconstruction --url https://mcp.openconstruction.org/mcp
codex mcp login openconstruction
```

Complete browser sign-in and select **Allow access**. Wait for the terminal to
confirm successful login. If tools are missing from an existing session, restart
Codex or its extension and open a new session. See [MCP setup and troubleshooting](docs/mcp.md).

For local MCP, install this package and configure your client to launch
`openconstruction-mcp` over stdio. Then ask:

> Download the dataset "CHVG" using OpenConstruction MCP.

The normal flow is **Download dataset → review the license → confirm → receive
files or links**. License review is included in the download call. You do not
need to request a separate download plan. Reconnect or restart an existing MCP
client to load the updated tools.

Version 0.1.1 adds native license confirmation to local and hosted MCP.
Clients supporting MCP form elicitation show a license prompt. Other clients
must show the review, ask for agreement, and return its `review_id`.
Review the license and confirm before downloading. Local MCP saves files on
your computer; remote MCP returns supported public file links for your client
to save. A client without file-download support can display those links.
Hosted features depend on the deployed server version.

## Documentation

See the [OpenConstruction guide](https://www.openconstruction.org/mcp-cli.html).
Detailed CLI, MCP, catalog, and hosting guides are also bundled under
`share/openconstruction/docs` in your Python environment and in the source archive.

Developers with repository access can install a checkout with
`python -m pip install .`. See `docs/development.md` for checks.

The software is licensed under Apache 2.0; `LICENSE` and `NOTICE` are included
in both release archives. Dataset licenses and provider terms apply separately.
