Metadata-Version: 2.2
Name: simlir-mcp
Version: 0.1.1
Summary: A thin stdio MCP bridge for the simlir public product API
Author: simlir engineering
License: Copyright 2026 simlir Ltd
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            https://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Project-URL: Homepage, https://simlir.com/docs/mcp-setup
Project-URL: Documentation, https://simlir.com/docs/mcp-setup
Project-URL: Repository, https://github.com/simlir/simlir
Project-URL: Issues, https://github.com/simlir/simlir/issues
Keywords: mcp,model context protocol,product data,product search,ai
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: simlir<0.2.0,>=0.1.0

# simlir-mcp

Corrected release candidate (`simlir-mcp` 0.1.1) providing a thin Python stdio
adapter around the simlir public product API. It is intentionally separate from Simlir’s internal
repository-intelligence MCP server and contains no ingestion code, customer
data, database credentials, or internal repository tooling.

The historical PyPI 0.1.0 publication and its published-package install/runtime
smoke are verified. Corrected 0.1.1 metadata, project URLs, and the publication
workflow are prepared locally; republish and a fresh published-package smoke
remain pending.
The public adapter artefact is licensed under Apache-2.0, as recorded by Joe
Close, co-founder and legal/commercial reviewer. That licence covers this
package’s source, generated types, fixtures, examples, and documentation; it
does not grant rights to Simlir trademarks, the hosted service, returned data,
or Simlir’s internal implementation. Support, rollback, and MCP directory acceptance
remain separate gates; publication is not evidence that those gates are
complete.

## Local use

Install the published SDK and adapter:

```bash
python -m pip install simlir simlir-mcp
export SIMLIR_API_KEY=sk_your_key_here
python -m simlir_mcp
```

The adapter keeps JSON-RPC responses on stdout and writes only structured,
metadata-only diagnostics to stderr. Never put an API key in a checked-in
configuration file.

## Claude Desktop, Cursor, or VS Code

The intended local configuration is:

```json
{
  "mcpServers": {
    "simlir": {
      "command": "simlir-mcp",
      "env": {
        "SIMLIR_API_KEY": "${SIMLIR_API_KEY}"
      }
    }
  }
}
```

## Supported tools

| Tool | API operation |
| --- | --- |
| `simlir_search_products` | Semantic product search |
| `simlir_search_products_by_image` | Visual product search with optional natural-language context |
| `simlir_lookup_products_by_identifier` | Exact GTIN/MPN/SKU lookup |

Tool names, required arguments, markets, and response shapes are pinned to the
checked-in public contract. Update the contract first, then regenerate or
update both MCP adapters and their tests when the public API changes.

The image tool requires `image_url` and `market`. Its optional `query` field
adds shopper context such as a size, product role, compatibility requirement,
or use case; Simlir combines that context with the visual signal. Image-only
calls remain valid.

## Development

```bash
PYTHONPATH=../python-sdk/src:src python -m unittest discover -s tests -p 'test_*.py'
python -m compileall -q src
python -m pip wheel --no-deps --no-build-isolation --wheel-dir /tmp/simlir-python-mcp-wheel .
```
