mirror of
https://github.com/dnlbauer/cordra-mcp.git
synced 2026-09-10 21:55:30 +00:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8e6aa73f50 | ||
|
|
a4d12d526b | ||
|
|
ad6dce005b | ||
|
|
d42bb1a581 | ||
|
|
c3b202c998 | ||
|
|
0bee7f2775 | ||
|
|
adc24dd4ad | ||
|
|
99fdaadea6 | ||
|
|
8b0694dff1 | ||
|
|
ea9cf92b2c | ||
|
|
3c8367f804 | ||
|
|
0a9ba538ef | ||
|
|
eaa300b8c2 | ||
|
|
7b77186ced | ||
|
|
5451883739 | ||
|
|
7d74d8d9af | ||
|
|
f6bfb14b29 | ||
|
|
9c9594367c | ||
|
|
c75629e3ff | ||
|
|
f35305568c | ||
|
|
663e6c3064 | ||
|
|
e01d732014 | ||
|
|
3dc4e664af |
@@ -1,5 +1,7 @@
|
||||
FROM python:3.13-alpine
|
||||
|
||||
EXPOSE 8000
|
||||
|
||||
# Install package manager
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
|
||||
|
||||
@@ -18,4 +20,6 @@ COPY src src
|
||||
RUN uv sync \
|
||||
--locked
|
||||
|
||||
ENV CORDRA_RUN_MODE=http
|
||||
|
||||
CMD ["uv", "run", "cordra-mcp"]
|
||||
|
||||
47
README.md
47
README.md
@@ -18,29 +18,60 @@ ensuring safe exploration without risk of data modification or corruption.
|
||||
|
||||
## MCP Architecture
|
||||
|
||||
### Resources
|
||||
|
||||
- `cordra://objects/{prefix}/{suffix}` - Retrieve a specific object by its handle identifier
|
||||
- `cordra://schemas/{schema_name}` - Schema definition for a specific type.
|
||||
- `cordra://design` - Design document containing the overall structure and configuration of the Cordra repository.
|
||||
|
||||
### Tools
|
||||
|
||||
- `list_types` - List all available types in the Cordra repository.
|
||||
- Returns a JSON array of type names that are defined in the repository
|
||||
- Types are returned in sorted order
|
||||
|
||||
- `get_type_schema` - Retrieve the JSON schema definition for a specific type.
|
||||
- `type_name` - The name of the type (e.g., "Person", "Document", "Project")
|
||||
- Returns the full schema definition as JSON
|
||||
|
||||
- `get_object` - Retrieve a digital object by its complete ID/handle.
|
||||
- `object_id` - Complete object ID (e.g., "test/abc123")
|
||||
|
||||
- `search_objects` - Search for digital objects using a query string with pagination support.
|
||||
- `query` - Lucene/Solr compatible search query
|
||||
- `type` - Optional filter by object type
|
||||
- `limit` - Number of results per page (default: 1)
|
||||
- `limit` - Number of results per page (default: 25)
|
||||
- `page_num` - Page number to retrieve, 0-based (default: 0)
|
||||
|
||||
- `count_objects` - Count the total number of objects matching a query.
|
||||
- `query` - Lucene/Solr compatible search query
|
||||
- `type` - Optional filter by object type
|
||||
|
||||
- `get_design_object` - Retrieve the Cordra design object containing repository configuration.
|
||||
- Includes type definitions, workflow configurations, and system settings
|
||||
- Administrative privileges are typically required to access this object
|
||||
|
||||
#### Query Syntax
|
||||
|
||||
**CRITICAL**: JSON properties MUST be prefixed with `/`
|
||||
|
||||
✅ **Correct Examples:**
|
||||
- `/title:*report*` - Wildcard search in title field
|
||||
- `/author/name:Daniel` - Nested property access
|
||||
- `/status:active AND /priority:high` - Boolean operators
|
||||
- Use `type` parameter instead of including `type:` in query
|
||||
|
||||
❌ **Wrong (will fail):**
|
||||
- `name:John` - Missing `/` prefix
|
||||
- `author/name:Daniel` - Missing leading `/`
|
||||
- `type:Person` - Use the `type` parameter instead
|
||||
|
||||
**Operators:** `*` (wildcard), `?` (single char), `AND`, `OR`, `NOT`, `"phrases"`
|
||||
|
||||
## Configuration
|
||||
|
||||
The MCP server can be configured using environment variables with the `CORDRA_` prefix:
|
||||
The MCP server can be configured using environment variables:
|
||||
|
||||
- `CORDRA_BASE_URL` - Cordra server URL (default: `https://localhost:8443`)
|
||||
- `CORDRA_USERNAME` - Username for authentication (optional)
|
||||
- `CORDRA_PASSWORD` - Password for authentication (optional)
|
||||
- `CORDRA_VERIFY_SSL` - SSL certificate verification (default: `true`)
|
||||
- `CORDRA_TIMEOUT` - Request timeout in seconds (default: `30`)
|
||||
- `LOGLEVEL` - Logging level (default: `INFO`, options: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`)
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "cordra-mcp"
|
||||
version = "1.1.1"
|
||||
version = "1.4.0"
|
||||
description = "MCP server for Cordra digital object repository"
|
||||
authors = [
|
||||
{name = "Daniel Bauer", email = "github@dbauer.me"},
|
||||
@@ -61,6 +61,7 @@ ignore = ["E501"]
|
||||
python_version = "3.11"
|
||||
strict = true
|
||||
warn_return_any = true
|
||||
files = ["src", "tests"]
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = ["cordra.*"]
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""MCP server for Cordra digital object repository."""
|
||||
|
||||
__version__ = "1.1.1"
|
||||
__version__ = "1.4.0"
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
"""Configuration settings for the MCP Cordra server."""
|
||||
|
||||
from pydantic import Field
|
||||
from typing import Literal
|
||||
|
||||
from pydantic import Field, field_validator
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
|
||||
@@ -16,6 +18,10 @@ class CordraConfig(BaseSettings):
|
||||
default="https://localhost:8443",
|
||||
description="Base URL of the Cordra repository",
|
||||
)
|
||||
host: str = Field(
|
||||
default="0.0.0.0",
|
||||
description="The host under which the MCP server runs when deployed as http run_mode",
|
||||
)
|
||||
username: str | None = Field(
|
||||
default=None, description="Username for Cordra authentication"
|
||||
)
|
||||
@@ -26,3 +32,24 @@ class CordraConfig(BaseSettings):
|
||||
default=True, description="Whether to verify SSL certificates"
|
||||
)
|
||||
timeout: int = Field(default=30, description="Request timeout in seconds")
|
||||
run_mode: Literal["stdio", "http"] | None = Field(
|
||||
default="stdio", description="Run mode for the MCP client"
|
||||
)
|
||||
log_level: str = Field(
|
||||
default="INFO",
|
||||
description="Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
|
||||
validation_alias="LOGLEVEL",
|
||||
)
|
||||
|
||||
@field_validator("log_level", mode="before")
|
||||
@classmethod
|
||||
def validate_log_level(cls, v: str) -> str:
|
||||
"""Validate that log_level is a standard logging level."""
|
||||
level_str = str(v).upper().strip()
|
||||
valid_levels = {"DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"}
|
||||
|
||||
if level_str not in valid_levels:
|
||||
raise ValueError(
|
||||
f"Invalid log level '{v}'. Must be one of: {', '.join(valid_levels)}"
|
||||
)
|
||||
return level_str
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
"""MCP server for Cordra digital object repository."""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
|
||||
from mcp.server.fastmcp import FastMCP
|
||||
from mcp.server.fastmcp.resources import FunctionResource
|
||||
|
||||
from . import __version__
|
||||
from .client import (
|
||||
CordraAuthenticationError,
|
||||
CordraClient,
|
||||
@@ -16,56 +15,69 @@ from .client import (
|
||||
from .config import CordraConfig
|
||||
|
||||
# Initialize the MCP server
|
||||
mcp = FastMCP("cordra-mcp")
|
||||
config = CordraConfig()
|
||||
mcp = FastMCP("cordra-mcp", host=config.host, port=8000)
|
||||
|
||||
# Initialize Cordra client at startup
|
||||
config = CordraConfig()
|
||||
cordra_client = CordraClient(config)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
logger.setLevel(config.log_level)
|
||||
|
||||
|
||||
@mcp.tool(
|
||||
name="search_objects",
|
||||
title="Search Cordra Objects",
|
||||
description="""Search for digital objects in the Cordra repository using Lucene/Solr query syntax.
|
||||
description="""Search for digital objects using Lucene/Solr query syntax.
|
||||
|
||||
Examples:
|
||||
- /title:report - Find objects with 'report' in title
|
||||
- /author:smith - Find objects by author Smith
|
||||
- /name:John AND type:Person - Complex queries
|
||||
CRITICAL SYNTAX RULES:
|
||||
1. Properties MUST start with '/' - Example: /title:report
|
||||
2. Nested properties: /parent/child:value
|
||||
3. Use 'type' parameter - NEVER 'type:' in query
|
||||
4. Operators: * ? AND OR NOT "phrases"
|
||||
|
||||
Pagination:
|
||||
- Results are paginated with 0-based page numbering
|
||||
- Use 'limit' to control page size (default: 1)
|
||||
- Use 'page_num' to specify which page to retrieve (default: 0)
|
||||
✅ CORRECT:
|
||||
- /title:*report* /author/name:Daniel
|
||||
- /status:active AND /priority:high
|
||||
- query="/title:report", type="Document"
|
||||
|
||||
Returns a JSON list of matching objects with their full metadata."""
|
||||
❌ WRONG:
|
||||
- name:John (missing /)
|
||||
- author/name:Daniel (missing /)
|
||||
- type:Person (use type parameter)
|
||||
|
||||
Returns: {results: [ids], total_count, page_num, page_size}
|
||||
Pagination: limit (default 25), page_num (0-based)""",
|
||||
)
|
||||
async def search_objects(
|
||||
query: str,
|
||||
type: str | None = None,
|
||||
limit: int = 1,
|
||||
limit: int = 25,
|
||||
page_num: int = 0,
|
||||
) -> str:
|
||||
"""Search for digital objects in the Cordra repository with pagination support.
|
||||
|
||||
Args:
|
||||
query: The search query string (Lucene/Solr compatible). Examples:
|
||||
- "/title:report" - Find objects with "report" in title
|
||||
- "/author:smith" - Find objects by author Smith
|
||||
- "/name:John AND type:Person" - Complex queries
|
||||
query: Search query (Lucene/Solr). Properties MUST start with '/'.
|
||||
✅ CORRECT: /title:*report*, /author/name:Daniel
|
||||
❌ WRONG: name:John, author/name:Daniel, type:Person
|
||||
type: Optional filter by object type (e.g., "Person", "Document", "Project")
|
||||
limit: Page size - number of results per page (default: 1)
|
||||
limit: Page size - number of results per page (default: 25)
|
||||
page_num: Page number to retrieve, 0-based (default: 0 for first page)
|
||||
|
||||
Returns:
|
||||
JSON string containing list of matching objects with their full metadata
|
||||
JSON string containing object IDs and pagination info
|
||||
"""
|
||||
try:
|
||||
search_result = await cordra_client.find(query, object_type=type, page_size=limit, page_num=page_num)
|
||||
results = search_result["results"]
|
||||
return json.dumps(results, indent=2)
|
||||
search_result = await cordra_client.find(
|
||||
query, object_type=type, page_size=limit, page_num=page_num
|
||||
)
|
||||
|
||||
# Extract only the IDs from the results
|
||||
search_result["results"] = [obj["id"] for obj in search_result["results"]]
|
||||
# Rename for consistency with documentation
|
||||
search_result["total_count"] = search_result.pop("total_size")
|
||||
return json.dumps(search_result, indent=2)
|
||||
|
||||
except ValueError as e:
|
||||
raise RuntimeError(f"Invalid search parameters: {e}") from e
|
||||
@@ -75,35 +87,78 @@ async def search_objects(
|
||||
raise RuntimeError(f"Search failed: {e}") from e
|
||||
|
||||
|
||||
@mcp.resource(
|
||||
"cordra://objects/{prefix}/{suffix}",
|
||||
name="cordra-object",
|
||||
title="Retrieve Cordra Digital Object",
|
||||
description="Retrieve a Digital Object and Metadata from Cordra by its ID/handle.",
|
||||
mime_type="application/json",
|
||||
@mcp.tool(
|
||||
name="count_objects",
|
||||
title="Count Cordra Objects matching a query",
|
||||
description="""Count the total number of digital objects matching a search query.
|
||||
|
||||
Examples:
|
||||
- /title:report - Count objects with 'report' in title
|
||||
- type:Person - Find all Persons. Note that "type" is special and uses no slash "/"
|
||||
- /author/name:Daniel - Find objects with author Daniel as nested property.
|
||||
- /name:John AND type:Person - Complex queries
|
||||
|
||||
Returns the count of objects as integer.
|
||||
""",
|
||||
)
|
||||
async def get_cordra_object(prefix: str, suffix: str) -> str:
|
||||
"""Retrieve a Cordra digital object by its ID.
|
||||
async def count_objects(
|
||||
query: str,
|
||||
type: str | None = None,
|
||||
) -> str:
|
||||
"""Count digital objects in the Cordra repository matching a search query.
|
||||
|
||||
Args:
|
||||
prefix: The prefix part of the object ID (e.g., 'wildlive')
|
||||
suffix: The suffix part of the object ID (e.g., '7a4b7b65f8bb155ad36d')
|
||||
query: Search query (Lucene/Solr). Properties MUST start with '/'.
|
||||
✅ CORRECT: /title:*report*, /author/name:Daniel
|
||||
❌ WRONG: name:John, author/name:Daniel, type:Person
|
||||
type: Optional filter by object type (e.g., "Person", "Document", "Project")
|
||||
|
||||
Returns:
|
||||
JSON representation of the digital object
|
||||
integer with the number of objects matching the criteria.
|
||||
"""
|
||||
try:
|
||||
# Use page_size=1 to get minimal data, we only need the total count
|
||||
search_result = await cordra_client.find(
|
||||
query, object_type=type, page_size=1, page_num=0
|
||||
)
|
||||
|
||||
total_size: int = search_result["total_size"]
|
||||
return str(total_size)
|
||||
except ValueError as e:
|
||||
raise RuntimeError(f"Invalid search parameters: {e}") from e
|
||||
except CordraAuthenticationError as e:
|
||||
raise RuntimeError(f"Authentication failed: {e}") from e
|
||||
except CordraClientError as e:
|
||||
raise RuntimeError(f"Count failed: {e}") from e
|
||||
|
||||
|
||||
@mcp.tool(
|
||||
name="get_object",
|
||||
title="Get Cordra Object by ID",
|
||||
description="""Retrieve a digital object by its complete ID/handle.
|
||||
|
||||
Returns: Full object with metadata as JSON
|
||||
Example: get_object("test/abc123")""",
|
||||
)
|
||||
async def get_object(object_id: str) -> str:
|
||||
"""Retrieve a Cordra digital object by its complete ID.
|
||||
|
||||
Args:
|
||||
object_id: The complete object ID/handle (e.g., "test/abc123" or "wildlive/7a4b7b65f8bb155ad36d")
|
||||
|
||||
Returns:
|
||||
JSON string containing the complete digital object with all metadata
|
||||
|
||||
Raises:
|
||||
RuntimeError: If the object is not found or there's an API error
|
||||
"""
|
||||
|
||||
object_id = f"{prefix}/{suffix}"
|
||||
try:
|
||||
digital_object = await cordra_client.get_object(object_id)
|
||||
object_dict = digital_object.model_dump()
|
||||
return json.dumps(object_dict, indent=2)
|
||||
|
||||
except ValueError as e:
|
||||
raise RuntimeError(f"Invalid parameters: {e}") from e
|
||||
raise RuntimeError(f"Invalid object ID: {e}") from e
|
||||
except CordraNotFoundError as e:
|
||||
raise RuntimeError(f"Object not found: {object_id}") from e
|
||||
except CordraAuthenticationError as e:
|
||||
@@ -112,14 +167,18 @@ async def get_cordra_object(prefix: str, suffix: str) -> str:
|
||||
raise RuntimeError(f"Failed to retrieve object {object_id}: {e}") from e
|
||||
|
||||
|
||||
@mcp.resource(
|
||||
"cordra://design",
|
||||
name="cordra-design",
|
||||
title="Retrieve Cordra Design Object",
|
||||
description="Retrieve the Cordra design object containing repository configuration. Administrative privileges are typically required to access this object.",
|
||||
mime_type="application/json",
|
||||
@mcp.tool(
|
||||
name="get_design_object",
|
||||
title="Get Cordra Design Object",
|
||||
description="""
|
||||
The design object is the central location where Cordra stores its configuration,
|
||||
including type definitions, workflow configurations, and system settings.
|
||||
Administrative privileges are typically required to access this object.
|
||||
|
||||
Returns: The design object as JSON
|
||||
""",
|
||||
)
|
||||
async def get_cordra_design() -> str:
|
||||
async def get_cordra_design_object() -> str:
|
||||
"""Retrieve the Cordra design object containing repository configuration.
|
||||
|
||||
The design object is the central location where Cordra stores its configuration,
|
||||
@@ -145,32 +204,38 @@ async def get_cordra_design() -> str:
|
||||
raise RuntimeError(f"Failed to retrieve design object: {e}") from e
|
||||
|
||||
|
||||
async def create_schema_resource(schema_name: str) -> str:
|
||||
"""Create content for a specific schema resource."""
|
||||
try:
|
||||
schema_object = await cordra_client.get_schema(schema_name)
|
||||
schema_dict = schema_object.model_dump()
|
||||
return json.dumps(schema_dict, indent=2)
|
||||
except CordraNotFoundError as e:
|
||||
raise RuntimeError(f"Schema not found: {schema_name}") from e
|
||||
except CordraAuthenticationError as e:
|
||||
raise RuntimeError(f"Authentication failed: {e}") from e
|
||||
except CordraClientError as e:
|
||||
raise RuntimeError(f"Failed to retrieve schema {schema_name}: {e}") from e
|
||||
@mcp.tool(
|
||||
name="list_types",
|
||||
title="List Available Types",
|
||||
description="""List all available object types in the Cordra repository.
|
||||
|
||||
Returns a list of type names that are defined in the repository as json array.""",
|
||||
)
|
||||
async def list_types() -> str:
|
||||
"""List all available types in the Cordra repository.
|
||||
|
||||
async def register_schema_resources() -> None:
|
||||
"""Register individual schema resources dynamically."""
|
||||
Returns:
|
||||
JSON string containing a list of type names
|
||||
|
||||
Raises:
|
||||
RuntimeError: If there's an API error or authentication failure
|
||||
"""
|
||||
try:
|
||||
# Get all available schemas using pagination
|
||||
all_schemas = []
|
||||
# Get all available types using pagination
|
||||
all_types = []
|
||||
page_num = 0
|
||||
page_size = 20
|
||||
|
||||
while True:
|
||||
search_result = await cordra_client.find("type:Schema", page_size=page_size, page_num=page_num)
|
||||
search_result = await cordra_client.find(
|
||||
"type:Schema", page_size=page_size, page_num=page_num
|
||||
)
|
||||
schemas = search_result["results"]
|
||||
all_schemas.extend(schemas)
|
||||
|
||||
for schema in schemas:
|
||||
type_name = schema.get("content", {}).get("name")
|
||||
if type_name:
|
||||
all_types.append(type_name)
|
||||
|
||||
# Check if we've retrieved all schemas
|
||||
if len(schemas) < page_size:
|
||||
@@ -178,46 +243,58 @@ async def register_schema_resources() -> None:
|
||||
|
||||
page_num += 1
|
||||
|
||||
for schema in all_schemas:
|
||||
schema_name = schema.get("content", {}).get("name")
|
||||
if not schema_name:
|
||||
logger.warning("Schema without a name found, skipping.")
|
||||
continue
|
||||
all_types.sort()
|
||||
return json.dumps(all_types, indent=2)
|
||||
|
||||
logger.info(f"Registering schema resource for cordra type {schema_name}")
|
||||
|
||||
async def schema_fn(name: str = schema_name) -> str:
|
||||
return await create_schema_resource(name)
|
||||
|
||||
mcp.add_resource(
|
||||
FunctionResource.from_function(
|
||||
uri=f"cordra://schemas/{schema_name}",
|
||||
fn=schema_fn,
|
||||
name=f"cordra-type-schema-{schema_name}",
|
||||
title=f"Cordra Type Schema: {schema_name}",
|
||||
description=f"Retrieve the JSON schema for the Cordra Type {schema_name}",
|
||||
mime_type="application/json",
|
||||
)
|
||||
)
|
||||
|
||||
logger.info(f"Registered {len(all_schemas)} schema resources")
|
||||
|
||||
except Exception as e:
|
||||
logger.warning(f"Failed to register schema resources: {e}")
|
||||
except CordraAuthenticationError as e:
|
||||
raise RuntimeError(f"Authentication failed: {e}") from e
|
||||
except CordraClientError as e:
|
||||
raise RuntimeError(f"Failed to list types: {e}") from e
|
||||
|
||||
|
||||
@mcp.tool(
|
||||
name="get_type_schema",
|
||||
title="Get Type Schema",
|
||||
description="""Retrieve the JSON schema definition for a specific type.
|
||||
|
||||
async def initialize_server() -> None:
|
||||
"""Initialize server resources before starting."""
|
||||
logger.info("Initializing Cordra MCP server...")
|
||||
await register_schema_resources()
|
||||
logger.info("Server initialization complete")
|
||||
Args:
|
||||
type_name: The name of the type (e.g., "Person", "Document", "Project")
|
||||
|
||||
Returns: The full schema definition as JSON""",
|
||||
)
|
||||
async def get_type_schema(type_name: str) -> str:
|
||||
"""Retrieve the JSON schema definition for a specific object type.
|
||||
|
||||
Args:
|
||||
type_name: The name of the type to retrieve the schema for
|
||||
|
||||
Returns:
|
||||
JSON string containing the schema definition
|
||||
|
||||
Raises:
|
||||
RuntimeError: If the type is not found, authentication fails, or there's an API error
|
||||
"""
|
||||
try:
|
||||
schema_object = await cordra_client.get_schema(type_name)
|
||||
schema_dict = schema_object.model_dump()
|
||||
return json.dumps(schema_dict, indent=2)
|
||||
except CordraNotFoundError as e:
|
||||
raise RuntimeError(f"Type '{type_name}' not found") from e
|
||||
except CordraAuthenticationError as e:
|
||||
raise RuntimeError(f"Authentication failed: {e}") from e
|
||||
except CordraClientError as e:
|
||||
raise RuntimeError(
|
||||
f"Failed to retrieve schema for type '{type_name}': {e}"
|
||||
) from e
|
||||
|
||||
|
||||
def main() -> None:
|
||||
"""Main entry point for the MCP server."""
|
||||
asyncio.run(initialize_server())
|
||||
mcp.run()
|
||||
logger.info(f"Starting Cordra MCP server v{__version__}...")
|
||||
if config.run_mode == "stdio":
|
||||
mcp.run()
|
||||
else:
|
||||
mcp.run(transport="streamable-http")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
"""Unit tests for the Cordra client."""
|
||||
|
||||
from typing import Any
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
@@ -15,7 +16,7 @@ from cordra_mcp.config import CordraConfig
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def config():
|
||||
def config() -> CordraConfig:
|
||||
"""Create a test configuration."""
|
||||
return CordraConfig(
|
||||
base_url="https://test.example.com",
|
||||
@@ -26,13 +27,13 @@ def config():
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def client(config):
|
||||
def client(config: CordraConfig) -> CordraClient:
|
||||
"""Create a test client."""
|
||||
return CordraClient(config)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_cordra_object():
|
||||
def mock_cordra_object() -> dict[str, Any]:
|
||||
"""Create a mock CordraObject response (dictionary)."""
|
||||
return {
|
||||
"type": "TestType",
|
||||
@@ -59,7 +60,7 @@ def mock_cordra_object():
|
||||
class TestDigitalObject:
|
||||
"""Test the DigitalObject model."""
|
||||
|
||||
def test_digital_object_creation(self):
|
||||
def test_digital_object_creation(self) -> None:
|
||||
"""Test creating a DigitalObject."""
|
||||
obj = DigitalObject(
|
||||
id="test/123",
|
||||
@@ -89,7 +90,7 @@ class TestDigitalObject:
|
||||
assert payload["size"] == 1024
|
||||
assert payload["filename"] == "file1.txt"
|
||||
|
||||
def test_digital_object_optional_fields(self):
|
||||
def test_digital_object_optional_fields(self) -> None:
|
||||
"""Test DigitalObject with only required fields."""
|
||||
obj = DigitalObject(id="test/123", type="TestType", content={"title": "Test"})
|
||||
|
||||
@@ -104,13 +105,13 @@ class TestDigitalObject:
|
||||
class TestCordraClient:
|
||||
"""Test the CordraClient class."""
|
||||
|
||||
def test_client_initialization(self, config):
|
||||
def test_client_initialization(self, config: CordraConfig) -> None:
|
||||
"""Test client initialization."""
|
||||
client = CordraClient(config)
|
||||
assert client.config == config
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_object_success(self, mock_get, client, mock_cordra_object):
|
||||
async def test_get_object_success(self, mock_get: Any, client: CordraClient, mock_cordra_object: dict[str, Any]) -> None:
|
||||
"""Test successful object retrieval."""
|
||||
mock_response = mock_get.return_value
|
||||
mock_response.status_code = 200
|
||||
@@ -137,7 +138,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_object_not_found(self, mock_get, client):
|
||||
async def test_get_object_not_found(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test object not found exception."""
|
||||
mock_response = mock_get.return_value
|
||||
mock_response.status_code = 404
|
||||
@@ -149,7 +150,7 @@ class TestCordraClient:
|
||||
assert "Resource not found" in str(exc_info.value)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_object_general_error(self, mock_get, client):
|
||||
async def test_get_object_general_error(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test general error handling."""
|
||||
from requests import RequestException
|
||||
|
||||
@@ -161,7 +162,7 @@ class TestCordraClient:
|
||||
assert "Failed to retrieve object test/123" in str(exc_info.value)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_success(self, mock_get, client):
|
||||
async def test_find_success(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test successful find operation."""
|
||||
mock_response_data = {
|
||||
"results": [
|
||||
@@ -196,7 +197,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_empty_results(self, mock_get, client):
|
||||
async def test_find_empty_results(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find with empty results."""
|
||||
mock_response_data = {"results": [], "size": 0, "pageNum": 0, "pageSize": 20}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -218,7 +219,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_error(self, mock_get, client):
|
||||
async def test_find_error(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find error handling."""
|
||||
from requests import RequestException
|
||||
|
||||
@@ -231,7 +232,7 @@ class TestCordraClient:
|
||||
assert "Search failed" in str(exc_info.value)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_with_type_filter(self, mock_get, client):
|
||||
async def test_find_with_type_filter(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with type filter constructs correct query."""
|
||||
mock_response_data = {"results": [], "size": 0, "pageNum": 0, "pageSize": 20}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -248,7 +249,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_with_page_size(self, mock_get, client):
|
||||
async def test_find_with_page_size(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with custom page size."""
|
||||
mock_response_data = {"results": [], "size": 0, "pageNum": 0, "pageSize": 50}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -265,7 +266,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_with_type_and_page_size(self, mock_get, client):
|
||||
async def test_find_with_type_and_page_size(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with both type filter and page size."""
|
||||
mock_response_data = {"results": [], "size": 0, "pageNum": 0, "pageSize": 25}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -282,7 +283,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_default_params(self, mock_get, client):
|
||||
async def test_find_default_params(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with default parameters."""
|
||||
mock_response_data = {"results": [], "size": 0, "pageNum": 0, "pageSize": 20}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -299,7 +300,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_with_page_num(self, mock_get, client):
|
||||
async def test_find_with_page_num(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with specific page number."""
|
||||
mock_response_data = {"results": [], "size": 100, "pageNum": 2, "pageSize": 20}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -319,7 +320,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_find_with_custom_page_size_and_num(self, mock_get, client):
|
||||
async def test_find_with_custom_page_size_and_num(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test find operation with custom page size and page number."""
|
||||
mock_response_data = {"results": [], "size": 500, "pageNum": 5, "pageSize": 10}
|
||||
mock_response = mock_get.return_value
|
||||
@@ -339,7 +340,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_design_success(self, mock_get, client):
|
||||
async def test_get_design_success(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test successful design object retrieval."""
|
||||
mock_design_data = {
|
||||
"type": "CordraDesign",
|
||||
@@ -368,7 +369,7 @@ class TestCordraClient:
|
||||
)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_design_authentication_error(self, mock_get, client):
|
||||
async def test_get_design_authentication_error(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test design object retrieval with authentication error."""
|
||||
mock_response = mock_get.return_value
|
||||
mock_response.status_code = 403
|
||||
@@ -380,7 +381,7 @@ class TestCordraClient:
|
||||
assert "Authentication failed" in str(exc_info.value)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_design_not_found(self, mock_get, client):
|
||||
async def test_get_design_not_found(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test design object retrieval with not found error."""
|
||||
mock_response = mock_get.return_value
|
||||
mock_response.status_code = 404
|
||||
@@ -392,7 +393,7 @@ class TestCordraClient:
|
||||
assert "Resource not found" in str(exc_info.value)
|
||||
|
||||
@patch("cordra_mcp.client.requests.Session.get")
|
||||
async def test_get_design_request_error(self, mock_get, client):
|
||||
async def test_get_design_request_error(self, mock_get: Any, client: CordraClient) -> None:
|
||||
"""Test design object retrieval with request error."""
|
||||
from requests import RequestException
|
||||
|
||||
@@ -407,7 +408,7 @@ class TestCordraClient:
|
||||
class TestCordraConfig:
|
||||
"""Test the CordraConfig class."""
|
||||
|
||||
def test_default_config(self):
|
||||
def test_default_config(self) -> None:
|
||||
"""Test default configuration values."""
|
||||
config = CordraConfig()
|
||||
assert config.base_url == "https://localhost:8443"
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user