Repo: pal-e-docs-sdk

repo-pal-e-docs-sdk Doc

repo-page archived

Purpose

Typed Python SDK for the pal-e-docs REST API. Provides a PalEDocsClient class with httpx-based HTTP helpers, typed exceptions, Pydantic response models, and mixin-per-resource endpoint methods. The SDK sits between the FastAPI app and the MCP server -- integration tests run here, MCP tools wrap SDK methods.

Value

Eliminates raw httpx calls from MCP tools and scripts. Provides typed exceptions (NotFoundError, ValidationError, ServerError) instead of raw HTTP status codes. 15 typed methods across 6 mixins with Pydantic response models. Integration tests at this layer catch deployment failures automatically.

Usage

Status

v0.2.0 -- 15 typed endpoint methods across 6 mixins (notes, search, tags, projects, links, repos). 58 tests. Blocks and sprints coming in 8c/8d.

Architecture

Plans

Plan Phase Status Summary
<code>plan-2026-02-26-tf-modularize-postgres</code> Phase 8a COMPLETED SDK core scaffold -- client, exceptions, CI, PyPI publish
<code>plan-2026-02-26-tf-modularize-postgres</code> Phase 8b COMPLETED SDK: Notes, Search, Tags, Projects, Links, Repos -- 15 methods, 58 tests
<code>plan-2026-02-26-tf-modularize-postgres</code> Phase 8c NOT STARTED SDK: Blocks, TOC, Sections
<code>plan-2026-02-26-tf-modularize-postgres</code> Phase 8d NOT STARTED SDK: Sprints

Issues

None open.
  • phase-postgres-8-mcp-optimization -- parent phase
  • plan-2026-02-28-woodpecker-sdk-mcp -- the pattern this follows