harnessapi 0.1.0__tar.gz

harnessapi-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

harnessapi-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # needed to create GitHub releases
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

harnessapi-0.1.0/.gitignore

@@ -0,0 +1,183 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+/.agents
+skills-lock.json

harnessapi-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

harnessapi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edwin Jose
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

harnessapi-0.1.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: harnessapi
+Version: 0.1.0
+Summary: Skill-first API framework: every endpoint is also an MCP tool
+License-File: LICENSE
+Keywords: agents,fastapi,llm,mcp,skills,sse,streaming
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.0.0
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: fastmcp>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: sse-starlette>=2.0.0
+Requires-Dist: uvicorn[standard]>=0.30.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# harnessapi
+
+**Skill-first API framework** — define a skill once, get both an HTTP endpoint and an MCP tool automatically.
+
+Every skill is a folder. Drop in a `handler.py` and `models.py` and you have:
+- `POST /skills/{name}` — streaming SSE by default, JSON on request
+- An MCP tool at `/mcp` — ready for Claude Desktop, Cursor, or any MCP client
+
+---
+
+## Install
+
+```bash
+uv add harnessapi
+```
+
+Or clone and run locally:
+
+```bash
+git clone <repo>
+cd harnessapi
+uv sync
+```
+
+---
+
+## Quickstart
+
+Create your skill folder:
+
+```
+my_project/
+├── main.py
+└── skills/
+    └── greet/
+        ├── models.py
+        └── handler.py
+```
+
+**`skills/greet/models.py`**
+```python
+from harnessapi import SkillInput, SkillOutput
+
+class Input(SkillInput):
+    name: str
+
+class Output(SkillOutput):
+    message: str
+```
+
+**`skills/greet/handler.py`**
+```python
+"""Say hello to someone."""
+from .models import Input, Output
+
+async def handle(input: Input) -> Output:
+    return Output(message=f"Hello, {input.name}!")
+```
+
+**`main.py`**
+```python
+from pathlib import Path
+from harnessapi import HarnessAPI
+
+app = HarnessAPI(skills_dir=Path(__file__).parent / "skills")
+```
+
+Run it exactly like a FastAPI app:
+
+```bash
+uvicorn main:app --reload
+```
+
+---
+
+## Try the factorial example
+
+The repo ships with a streaming factorial skill that demonstrates SSE + MCP together.
+
+```bash
+# from the repo root
+uv run uvicorn examples.factorial_app.main:app --reload
+```
+
+### Call via HTTP — SSE stream (default)
+
+```bash
+curl -X POST http://localhost:8000/skills/factorial \
+  -H "Content-Type: application/json" \
+  -d '{"n": 5}'
+```
+
+Response (each multiplication step streamed as it's computed):
+
+```
+event: chunk
+data: start: 1
+
+event: chunk
+data: 2: 2
+
+event: chunk
+data: 3: 6
+
+event: chunk
+data: 4: 24
+
+event: chunk
+data: 5: 120
+
+event: done
+data:
+```
+
+### Call via HTTP — plain JSON
+
+```bash
+curl -X POST http://localhost:8000/skills/factorial \
+  -H "Content-Type: application/json" \
+  -H "Accept: application/json" \
+  -d '{"n": 5}'
+```
+
+```json
+{"chunks": ["start: 1", "2: 2", "3: 6", "4: 24", "5: 120"]}
+```
+
+### Connect an MCP client
+
+The MCP server is automatically available at:
+
+```
+http://localhost:8000/mcp
+```
+
+Add it to **Claude Desktop** (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "harnessapi": {
+      "url": "http://localhost:8000/mcp"
+    }
+  }
+}
+```
+
+Or add it to **Cursor** settings under MCP servers.
+
+The `factorial` skill is automatically registered as an MCP tool with parameter `input.n: int`.
+
+---
+
+## Skill folder structure
+
+```
+skills/
+└── my_skill/
+    ├── handler.py        # REQUIRED — async def handle(input: Input) -> Output
+    ├── models.py         # REQUIRED — class Input(SkillInput), class Output(SkillOutput)
+    ├── skill.toml        # optional — metadata
+    ├── defaults/
+    │   └── input.json    # optional — default values shown in OpenAPI docs
+    └── examples/
+        └── 01.json       # optional — {input: {...}, output: {...}} example pairs
+```
+
+**`skill.toml`** (all optional):
+```toml
+[skill]
+description  = "What this skill does"
+is_mcp       = true      # expose as MCP tool (default: true)
+tags         = ["math"]
+timeout_secs = 30
+```
+
+### Streaming vs non-streaming
+
+Return a value → non-streaming (single `result` SSE event):
+```python
+async def handle(input: Input) -> Output:
+    return Output(...)
+```
+
+Use `yield` → streaming (multiple `chunk` SSE events):
+```python
+async def handle(input: Input):
+    for item in compute_steps(input):
+        yield item
+```
+
+---
+
+## Decorator API (no folder needed)
+
+```python
+from harnessapi import HarnessAPI, SkillInput, SkillOutput, skill
+
+class TranslateInput(SkillInput):
+    text: str
+    target_lang: str = "es"
+
+class TranslateOutput(SkillOutput):
+    translated: str
+
+@skill(
+    name="translate",
+    input_model=TranslateInput,
+    output_model=TranslateOutput,
+    is_mcp=True,
+)
+async def translate_handler(input: TranslateInput) -> TranslateOutput:
+    return TranslateOutput(translated=f"[{input.target_lang}] {input.text}")
+
+app = HarnessAPI(title="My Skills")
+```
+
+---
+
+## Runtime edit endpoint (advanced)
+
+Enable hot-swapping a skill's handler over HTTP:
+
+```python
+app = HarnessAPI(skills_dir="./skills", enable_edit_endpoints=True)
+```
+
+```bash
+curl -X POST http://localhost:8000/skills/factorial/edit \
+  -H "Content-Type: application/json" \
+  -d '{
+    "source_code": "async def handle(input):\n    yield f\"custom: {input.n}\"",
+    "persist": false
+  }'
+```
+
+> **Security note**: The edit endpoint executes arbitrary Python. Always protect it with authentication middleware in production. It is disabled by default.
+
+---
+
+## SSE event protocol
+
+| Event    | When                                      |
+|----------|-------------------------------------------|
+| `chunk`  | Each yielded value from a streaming handler |
+| `result` | The final output of a non-streaming handler |
+| `done`   | Always the last event                     |
+| `error`  | Handler raised an exception               |
+
+---
+
+## OpenAPI docs
+
+Interactive docs are available at `http://localhost:8000/docs` — all skills appear as documented POST endpoints with their Pydantic schemas.