Skip to main content

MCP server for Colectica Repository REST API

Project description

Colectica MCP Server

MCP server for Colectica Repository REST API with:

  • OpenAPI/Swagger discovery
  • operation invocation by OpenAPI operationId or synthesized id (METHOD_path_segments)
  • Basic Auth and Bearer Token support
  • stdio transport now, optional streamable-http transport switch

1. Install

python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -e .

2. Configure

Copy .env.example to .env and set values:

  • COLECTICA_BASE_URL (your Colectica Portal URL)
  • either COLECTICA_BEARER_TOKEN or COLECTICA_USERNAME + COLECTICA_PASSWORD (or both)

Optional:

  • COLECTICA_OPENAPI_CACHE_TTL_SECONDS (default 300; set 0 to disable cache)
  • COLECTICA_RETRY_MAX_RETRIES (default 2)
  • COLECTICA_RETRY_BASE_SECONDS (default 0.5)
  • COLECTICA_RETRY_MAX_SECONDS (default 8)

3. Run MCP server

stdio (default)

colectica-mcp --transport stdio

streamable-http (optional)

colectica-mcp --transport streamable-http --mount-path /mcp

4. Available MCP tools

  • health_check(auth_mode="auto")
  • list_operations(auth_mode="auto")
  • find_operations(query, auth_mode="auto", limit=50)
  • find_ddi_operations(auth_mode="auto", limit=50)
  • call_operation(operation_id, arguments, auth_mode="auto")
  • call_endpoint(method, path, arguments, auth_mode="auto")
  • operation_details(operation_id, auth_mode="auto")
  • call_operation_paginated(operation_id, arguments, auth_mode="auto", max_pages=20, items_path=None)
  • list_operation_categories(auth_mode="auto")
  • list_operations_by_category(category, auth_mode="auto", limit=200)
  • get_repository_info(auth_mode="auto")
  • get_item(arguments, auth_mode="auto")
  • search(arguments, auth_mode="auto")
  • register_item(arguments, auth_mode="auto")
  • get_item_by_urn(urn, auth_mode="auto")
  • register_item_body(body, auth_mode="auto")
  • get_ddi_fragment(agency, identifier, version=None, auth_mode="auto")
  • get_ddi_set_fragment(agency, identifier, version=None, auth_mode="auto")
  • get_item_json(agency, identifier, version=None, auth_mode="auto")
  • get_item_json_set(agency, identifier, version=None, auth_mode="auto")
  • get_item_json_set_filtered(body, auth_mode="auto")

5. Recommended usage flow

  1. health_check
  2. list_operations
  3. list_operation_categories to see API groups (Agency, Comment, Ddi, Event, Item, Permission, Query, Rating, Replication, Repository, Set, Setting, Tag, Token, Transaction, VersionNumber)
  4. list_operations_by_category to narrow to one group
  5. call_operation using operationId and arguments from your Swagger schema

For request bodies, pass arguments.body.

If you prefer to execute directly from HTTP route + verb, use call_endpoint(method, path, arguments, auth_mode).

If your OpenAPI spec does not provide operationId values, use synthesized ids in this format:

  • METHOD_<normalized_path>
  • Example: GET /api/v1/ddi/{agency}/{identifier} -> GET_api_v1_ddi_agency_identifier

Optional for non-JSON operations:

  • arguments.content_type (for example application/x-www-form-urlencoded or multipart/form-data)

Use operation_details to inspect supported parameters and request body content types before invoking. For paged endpoints, use call_operation_paginated to aggregate items across pages. The server will follow continuation tokens when available, including body tokens like nextResult for query endpoints.

6. DDI integration workflow

Use this sequence to integrate with DDI-focused Colectica endpoints:

  1. Call convenience wrappers directly: get_ddi_fragment, get_ddi_set_fragment, get_item_json, get_item_json_set.
  2. Use get_item_json_set_filtered for selective graph traversal.
  3. For advanced/non-wrapped routes, run find_ddi_operations and confirm with operation_details(operation_id).
  4. Execute custom integration calls via call_operation using typed arguments and arguments.body.
  5. For large result sets, switch to call_operation_paginated.

7. Verification commands

Run Colectica server tool unit tests locally:

python -m unittest tests/test_server_tools.py tests/test_client_pagination.py -v

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colectica_mcp_server-0.1.8.tar.gz (62.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

colectica_mcp_server-0.1.8-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file colectica_mcp_server-0.1.8.tar.gz.

File metadata

  • Download URL: colectica_mcp_server-0.1.8.tar.gz
  • Upload date:
  • Size: 62.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for colectica_mcp_server-0.1.8.tar.gz
Algorithm Hash digest
SHA256 c11b0f9600ef4cea21cf693dad7382eadca47295206b496f2ad749781061f471
MD5 a887b83f8f4c10d1dd35ed7fc17ab0c9
BLAKE2b-256 f87a372a54c805cf406f5c73834a5283d54f974ce5bdc926b573f2d952faedba

See more details on using hashes here.

Provenance

The following attestation bundles were made for colectica_mcp_server-0.1.8.tar.gz:

Publisher: publish-to-pypi.yml on Keayoub/colectica-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file colectica_mcp_server-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for colectica_mcp_server-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 248ec659bcc9abf47ffc4e2ae3f60c1a536bdf8faae1114df74b91bdb9283292
MD5 210b04836e2f88aa75f3fb077632660f
BLAKE2b-256 3452db39d16298928d37b76434c74ca4d0bb2f6168f094b99a7ab882b58090b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for colectica_mcp_server-0.1.8-py3-none-any.whl:

Publisher: publish-to-pypi.yml on Keayoub/colectica-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page