testmcpy 0.1.0__tar.gz

testmcpy-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

testmcpy-0.1.0/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: testmcpy
+Version: 0.1.0
+Summary: A comprehensive testing framework for validating LLM tool calling capabilities with MCP services
+Author-email: Preset <amin@preset.io>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/preset-io/testmcpy
+Project-URL: Repository, https://github.com/preset-io/testmcpy
+Project-URL: Issues, https://github.com/preset-io/testmcpy/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: ollama>=0.1.0
+Requires-Dist: anthropic>=0.39.0
+Requires-Dist: fastmcp>=0.2.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: shellingham>=1.3.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Dynamic: license-file
+
+# testmcpy - MCP Testing Framework
+
+A comprehensive testing framework for validating LLM tool calling capabilities with MCP (Model Context Protocol) services, specifically designed for testing Superset operations.
+
+## Quick Start
+
+### Installation
+
+**From source (development):**
+```bash
+git clone https://github.com/preset-io/testmcpy.git
+cd testmcpy
+pip install -e .
+```
+
+**From PyPI (once published):**
+```bash
+pip install testmcpy
+```
+
+**Via Homebrew (once published to PyPI):**
+```bash
+brew tap preset-io/testmcpy
+brew install testmcpy
+```
+
+See [INSTALLATION.md](INSTALLATION.md) for detailed installation instructions and distribution options.
+
+### Quick Usage
+
+```bash
+# List MCP tools
+testmcpy tools
+testmcpy tools --detail --filter chart
+
+# Research LLM capabilities
+testmcpy research --model claude-sonnet-4.5-20250929 --provider anthropic
+
+# Run test suites
+testmcpy run tests/ --model claude-3-5-haiku-20241022 --provider anthropic
+
+# Interactive chat
+testmcpy chat --provider anthropic --model claude-sonnet-4.5-20250929
+
+# Compare test results
+testmcpy report reports/model1.yaml reports/model2.yaml
+
+# Initialize new project
+testmcpy init my_project
+```
+
+## Framework Structure
+
+```
+mcp_testing/
+├── research/               # Research scripts for testing LLM capabilities
+│   └── test_ollama_tools.py
+├── src/                    # Core framework modules
+│   ├── mcp_client.py      # MCP protocol client
+│   ├── llm_integration.py # LLM provider abstraction
+│   └── test_runner.py     # Test execution engine
+├── evals/                  # Evaluation functions
+│   └── base_evaluators.py # Standard evaluators
+├── tests/                  # Test cases (YAML/JSON)
+│   ├── basic_test.yaml
+│   └── example_mcp_tests.yaml
+├── reports/                # Test reports and comparisons
+└── cli.py                  # CLI interface
+
+```
+
+## Writing Test Cases
+
+Test cases are defined in YAML files:
+
+```yaml
+version: "1.0"
+name: "My Test Suite"
+
+tests:
+  - name: "test_chart_creation"
+    prompt: "Create a bar chart showing sales by region"
+    expected_tools:
+      - "create_chart"
+    evaluators:
+      - name: "was_mcp_tool_called"
+        args:
+          tool_name: "create_chart"
+      - name: "execution_successful"
+      - name: "final_answer_contains"
+        args:
+          expected_content: ["chart", "created"]
+      - name: "within_time_limit"
+        args:
+          max_seconds: 30
+```
+
+## Available Evaluators
+
+### Generic Evaluators
+- `was_mcp_tool_called` - Verify MCP tool was called
+- `execution_successful` - Check for successful execution
+- `final_answer_contains` - Validate response content
+- `answer_contains_link` - Check for links in response
+- `within_time_limit` - Verify performance
+- `token_usage_reasonable` - Check token/cost efficiency
+
+### Superset-Specific Evaluators
+- `was_superset_chart_created` - Verify chart creation
+- `sql_query_valid` - Validate SQL syntax
+
+## Supported LLM Providers
+
+- **Claude Agent SDK** (`claude-sdk`) - Official Anthropic SDK ⚠️ **Limited MCP Support**
+  - claude-sonnet-4.5-20250929 (newest, most capable)
+  - claude-sonnet-4-20250514
+  - claude-3-5-sonnet-20241022
+  - claude-3-5-haiku-20241022
+  - All Claude models
+  - Requires: `ANTHROPIC_API_KEY` environment variable
+  - Features: Native tool calling, streaming, hooks
+  - **Note**: Designed for stdio-based MCP servers, **not HTTP-based services**
+  - **For HTTP MCP (like Superset)**: Use `anthropic` provider instead
+
+- **Anthropic API** (`anthropic`) - Direct API integration ✅ **Recommended for HTTP MCP**
+  - claude-sonnet-4.5-20250929 (newest, recommended)
+  - claude-sonnet-4-20250514
+  - claude-3-5-sonnet-20241022
+  - claude-3-5-haiku-20241022 (fast, cost-effective)
+  - claude-3-opus-20240229
+  - All Claude models via API
+  - Requires: `ANTHROPIC_API_KEY` environment variable
+  - **Full support for HTTP-based MCP services** (like Superset MCP)
+  - Best choice for production testing with MCP tools
+
+- **Ollama** (`ollama`) - Local models with tool calling support
+  - llama3.1:8b (recommended)
+  - mistral-nemo
+  - qwen2.5:7b
+
+- **OpenAI** (`openai`) - GPT models via API
+  - Requires: `OPENAI_API_KEY` environment variable
+
+- **Local** (`local`) - Transformers-based local models
+
+- **Claude CLI** (`claude-cli`) - Claude Code CLI interface
+  - Uses Claude Code binary
+
+## Configuration
+
+### Environment Variables
+
+```bash
+# For Claude providers (claude-sdk, anthropic)
+export ANTHROPIC_API_KEY="sk-ant-..."
+
+# For OpenAI provider
+export OPENAI_API_KEY="sk-..."
+
+# MCP service URL (optional, defaults to http://localhost:5008/mcp/)
+export MCP_URL="http://localhost:5008/mcp/"
+
+# Default model and provider (optional)
+export DEFAULT_MODEL="claude-sonnet-4.5-20250929"
+export DEFAULT_PROVIDER="anthropic"
+```
+
+### Configuration File
+
+Create `mcp_test_config.yaml`:
+
+```yaml
+mcp_url: "http://localhost:5008/mcp"
+default_model: "claude-sonnet-4.5-20250929"
+default_provider: "anthropic"
+evaluators:
+  timeout: 30
+  max_tokens: 2000
+  max_cost: 0.10
+```
+
+## Development Status
+
+### Phase 0: Research & Prototype ✅
+- [x] Research local LLM options with tool calling
+- [x] Build minimal Python script for LLM+MCP integration
+- [x] Validate tool calling with selected LLM
+- [x] Create basic framework structure
+
+### Phase 1: Foundation (In Progress)
+- [x] CLI framework with typer + rich
+- [x] Basic test execution engine
+- [x] MCP protocol client
+- [x] LLM provider abstraction
+- [x] Core evaluation functions
+- [ ] Integration with existing Superset tests
+
+### Phase 2: Core Features (Planned)
+- [ ] Multi-model comparison support
+- [ ] Advanced reporting with charts
+- [ ] Test suite versioning
+- [ ] Parallel test execution
+
+### Phase 3: Advanced Capabilities (Future)
+- [ ] CI/CD integration
+- [ ] Interactive test development mode
+- [ ] Performance profiling
+- [ ] Cost optimization insights
+
+## Known Limitations
+
+- **Claude SDK Provider**: Only supports stdio-based MCP servers (command-line tools)
+  - **Not compatible** with HTTP-based MCP services (like Superset MCP)
+  - Use `anthropic` provider for HTTP MCP services
+- **HTTP MCP Services**: Use `anthropic` provider (fully supported)
+- **Ollama models**: Require specific formatting for reliable tool calling
+- **CPU-only execution**: May be slow for larger local models
+- **Tool calling accuracy**: Varies by model (Claude models generally most reliable)
+- **Cost**: Claude API providers (`anthropic`) incur API costs; consider using Ollama for development
+
+## Contributing
+
+This framework follows the patterns established by promptimize and superset-sup. When contributing:
+
+1. Use modern Python practices (type hints, async/await)
+2. Follow the existing code style
+3. Add tests for new evaluators
+4. Document new features in this README
+
+## License
+
+Same as the parent promptimize project.

testmcpy-0.1.0/README.md

@@ -0,0 +1,232 @@
+# testmcpy - MCP Testing Framework
+
+A comprehensive testing framework for validating LLM tool calling capabilities with MCP (Model Context Protocol) services, specifically designed for testing Superset operations.
+
+## Quick Start
+
+### Installation
+
+**From source (development):**
+```bash
+git clone https://github.com/preset-io/testmcpy.git
+cd testmcpy
+pip install -e .
+```
+
+**From PyPI (once published):**
+```bash
+pip install testmcpy
+```
+
+**Via Homebrew (once published to PyPI):**
+```bash
+brew tap preset-io/testmcpy
+brew install testmcpy
+```
+
+See [INSTALLATION.md](INSTALLATION.md) for detailed installation instructions and distribution options.
+
+### Quick Usage
+
+```bash
+# List MCP tools
+testmcpy tools
+testmcpy tools --detail --filter chart
+
+# Research LLM capabilities
+testmcpy research --model claude-sonnet-4.5-20250929 --provider anthropic
+
+# Run test suites
+testmcpy run tests/ --model claude-3-5-haiku-20241022 --provider anthropic
+
+# Interactive chat
+testmcpy chat --provider anthropic --model claude-sonnet-4.5-20250929
+
+# Compare test results
+testmcpy report reports/model1.yaml reports/model2.yaml
+
+# Initialize new project
+testmcpy init my_project
+```
+
+## Framework Structure
+
+```
+mcp_testing/
+├── research/               # Research scripts for testing LLM capabilities
+│   └── test_ollama_tools.py
+├── src/                    # Core framework modules
+│   ├── mcp_client.py      # MCP protocol client
+│   ├── llm_integration.py # LLM provider abstraction
+│   └── test_runner.py     # Test execution engine
+├── evals/                  # Evaluation functions
+│   └── base_evaluators.py # Standard evaluators
+├── tests/                  # Test cases (YAML/JSON)
+│   ├── basic_test.yaml
+│   └── example_mcp_tests.yaml
+├── reports/                # Test reports and comparisons
+└── cli.py                  # CLI interface
+
+```
+
+## Writing Test Cases
+
+Test cases are defined in YAML files:
+
+```yaml
+version: "1.0"
+name: "My Test Suite"
+
+tests:
+  - name: "test_chart_creation"
+    prompt: "Create a bar chart showing sales by region"
+    expected_tools:
+      - "create_chart"
+    evaluators:
+      - name: "was_mcp_tool_called"
+        args:
+          tool_name: "create_chart"
+      - name: "execution_successful"
+      - name: "final_answer_contains"
+        args:
+          expected_content: ["chart", "created"]
+      - name: "within_time_limit"
+        args:
+          max_seconds: 30
+```
+
+## Available Evaluators
+
+### Generic Evaluators
+- `was_mcp_tool_called` - Verify MCP tool was called
+- `execution_successful` - Check for successful execution
+- `final_answer_contains` - Validate response content
+- `answer_contains_link` - Check for links in response
+- `within_time_limit` - Verify performance
+- `token_usage_reasonable` - Check token/cost efficiency
+
+### Superset-Specific Evaluators
+- `was_superset_chart_created` - Verify chart creation
+- `sql_query_valid` - Validate SQL syntax
+
+## Supported LLM Providers
+
+- **Claude Agent SDK** (`claude-sdk`) - Official Anthropic SDK ⚠️ **Limited MCP Support**
+  - claude-sonnet-4.5-20250929 (newest, most capable)
+  - claude-sonnet-4-20250514
+  - claude-3-5-sonnet-20241022
+  - claude-3-5-haiku-20241022
+  - All Claude models
+  - Requires: `ANTHROPIC_API_KEY` environment variable
+  - Features: Native tool calling, streaming, hooks
+  - **Note**: Designed for stdio-based MCP servers, **not HTTP-based services**
+  - **For HTTP MCP (like Superset)**: Use `anthropic` provider instead
+
+- **Anthropic API** (`anthropic`) - Direct API integration ✅ **Recommended for HTTP MCP**
+  - claude-sonnet-4.5-20250929 (newest, recommended)
+  - claude-sonnet-4-20250514
+  - claude-3-5-sonnet-20241022
+  - claude-3-5-haiku-20241022 (fast, cost-effective)
+  - claude-3-opus-20240229
+  - All Claude models via API
+  - Requires: `ANTHROPIC_API_KEY` environment variable
+  - **Full support for HTTP-based MCP services** (like Superset MCP)
+  - Best choice for production testing with MCP tools
+
+- **Ollama** (`ollama`) - Local models with tool calling support
+  - llama3.1:8b (recommended)
+  - mistral-nemo
+  - qwen2.5:7b
+
+- **OpenAI** (`openai`) - GPT models via API
+  - Requires: `OPENAI_API_KEY` environment variable
+
+- **Local** (`local`) - Transformers-based local models
+
+- **Claude CLI** (`claude-cli`) - Claude Code CLI interface
+  - Uses Claude Code binary
+
+## Configuration
+
+### Environment Variables
+
+```bash
+# For Claude providers (claude-sdk, anthropic)
+export ANTHROPIC_API_KEY="sk-ant-..."
+
+# For OpenAI provider
+export OPENAI_API_KEY="sk-..."
+
+# MCP service URL (optional, defaults to http://localhost:5008/mcp/)
+export MCP_URL="http://localhost:5008/mcp/"
+
+# Default model and provider (optional)
+export DEFAULT_MODEL="claude-sonnet-4.5-20250929"
+export DEFAULT_PROVIDER="anthropic"
+```
+
+### Configuration File
+
+Create `mcp_test_config.yaml`:
+
+```yaml
+mcp_url: "http://localhost:5008/mcp"
+default_model: "claude-sonnet-4.5-20250929"
+default_provider: "anthropic"
+evaluators:
+  timeout: 30
+  max_tokens: 2000
+  max_cost: 0.10
+```
+
+## Development Status
+
+### Phase 0: Research & Prototype ✅
+- [x] Research local LLM options with tool calling
+- [x] Build minimal Python script for LLM+MCP integration
+- [x] Validate tool calling with selected LLM
+- [x] Create basic framework structure
+
+### Phase 1: Foundation (In Progress)
+- [x] CLI framework with typer + rich
+- [x] Basic test execution engine
+- [x] MCP protocol client
+- [x] LLM provider abstraction
+- [x] Core evaluation functions
+- [ ] Integration with existing Superset tests
+
+### Phase 2: Core Features (Planned)
+- [ ] Multi-model comparison support
+- [ ] Advanced reporting with charts
+- [ ] Test suite versioning
+- [ ] Parallel test execution
+
+### Phase 3: Advanced Capabilities (Future)
+- [ ] CI/CD integration
+- [ ] Interactive test development mode
+- [ ] Performance profiling
+- [ ] Cost optimization insights
+
+## Known Limitations
+
+- **Claude SDK Provider**: Only supports stdio-based MCP servers (command-line tools)
+  - **Not compatible** with HTTP-based MCP services (like Superset MCP)
+  - Use `anthropic` provider for HTTP MCP services
+- **HTTP MCP Services**: Use `anthropic` provider (fully supported)
+- **Ollama models**: Require specific formatting for reliable tool calling
+- **CPU-only execution**: May be slow for larger local models
+- **Tool calling accuracy**: Varies by model (Claude models generally most reliable)
+- **Cost**: Claude API providers (`anthropic`) incur API costs; consider using Ollama for development
+
+## Contributing
+
+This framework follows the patterns established by promptimize and superset-sup. When contributing:
+
+1. Use modern Python practices (type hints, async/await)
+2. Follow the existing code style
+3. Add tests for new evaluators
+4. Document new features in this README
+
+## License
+
+Same as the parent promptimize project.