{"id":31156105,"url":"https://github.com/aborroy/kd-agent-connector","last_synced_at":"2025-09-18T20:54:50.774Z","repository":{"id":307503393,"uuid":"1028443667","full_name":"aborroy/kd-agent-connector","owner":"aborroy","description":"Alfresco Repository addon to connect with Hyland Knowledge Discovery service","archived":false,"fork":false,"pushed_at":"2025-07-31T14:07:12.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-31T18:00:48.476Z","etag":null,"topics":["alfresco","hyland-experience","java"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aborroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-29T14:35:53.000Z","updated_at":"2025-07-31T14:07:16.000Z","dependencies_parsed_at":"2025-07-31T18:00:51.446Z","dependency_job_id":"d0b4970e-be05-4b2d-aea6-1a517c2cc74c","html_url":"https://github.com/aborroy/kd-agent-connector","commit_stats":null,"previous_names":["aborroy/kd-agent-connector"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/aborroy/kd-agent-connector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Fkd-agent-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Fkd-agent-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Fkd-agent-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Fkd-agent-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aborroy","download_url":"https://codeload.github.com/aborroy/kd-agent-connector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aborroy%2Fkd-agent-connector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275830188,"owners_count":25536280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-18T02:00:09.552Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alfresco","hyland-experience","java"],"created_at":"2025-09-18T20:54:48.886Z","updated_at":"2025-09-18T20:54:50.766Z","avatar_url":"https://github.com/aborroy.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hyland Knowledge Discovery Agent Connector\n\n**KD Agent Connector** is an Alfresco Platform (ACS) repository module that exposes a thin, secure REST façade over Hyland Knowledge Discovery *Agent Builder* API.\nIt lets any Alfresco‑authenticated user\n\n* discover available **AI agents** (`GET /kd/agents`) and\n* ask questions to a selected agent (`POST /kd/prompt`),\n\nreceiving structured answers plus the source‑document references the agent used.\n\nThe module is packaged as a single JAR and is compatible with Alfresco **ACS 23.1 to 25.x** (tested with 25.1 Community). No Share or ADF code is required.\n\n## Why you might care\n\nSkip building a full‑blown middleware: this add‑on already solves OAuth2 token caching, pagination and error handling. If your goal is *\"Chat with KD agents from Alfresco\"*, this is the *one* component you need.\n\n## Prerequisites\n\n| Component                 | Version     | Notes                                                          |\n| ------------------------- | ----------- | -------------------------------------------------------------- |\n| Java JDK                  | 21+         | Compiled for 17 – runs fine on modern LTS JDKs.                |\n| Maven                     | ≥ 3.8       | Wrapper not included – install Maven locally.                  |\n| Alfresco Content Services | 23.1–25.x   | Community or Enterprise.                                       |\n| Network access            | HTTPS 443   | Outbound to **api.ai.dev.experience.hyland.com** and your IdP. |\n\n## Build the JAR\n\n```bash\ngit clone https://github.com/your-org/kd-agent-connector.git\ncd kd-agent-connector\nmvn clean package -DskipTests\n```\n\nThe addon is created at\n`target/kd-agent-connector-\u003cversion\u003e.jar`.\n\n## Configuration\n\nCopy the following properties into *alfresco‑global.properties* (or set them as environment variables):\n\n```properties\n# --- KD OAuth 2.0 ---\napp.knowledge-discovery.client-id = \u003cyour‑client‑id\u003e\napp.knowledge-discovery.client-secret = \u003cyour‑client‑secret\u003e\napp.knowledge-discovery.oauth-url = https://auth.iam.dev.experience.hyland.com/idp\n\n# --- KD API ---\napp.knowledge-discovery.api-url = https://api.ai.dev.experience.hyland.com\napp.knowledge-discovery.hx-env-id = \u003cenvironment‑uuid\u003e\n```\n\n\u003e **Keep secrets out of VCS** – externalise them via Docker secrets, Kubernetes config‑maps or your preferred secret store.\n\n## REST End‑points\n\n| Method | URL                                       | Auth          | Description                                                                        |\n| ------ | ----------------------------------------- | ------------- | ---------------------------------------------------------------------------------- |\n| `GET`  | `/alfresco/s/kd/agents?offset=0\u0026limit=20` | Alfresco user | Returns a paginated list of available RAG agents plus counters by type and status. |\n| `POST` | `/alfresco/s/kd/prompt`                   | Alfresco user | Invokes the latest version of the given agent.                                     |\n\n## Deployment\n\nPick the scenario that matches your environment.\n\n### 1. Docker‑based ACS (official images)\n\n1. **Build** the JAR (see above) or grab it from your CI artifact repo.\n\n2. Create an *extensions* folder next to your `docker-compose.yml` and copy the JAR there.\n\n3. Add a volume to the `alfresco` service:\n\n   ```yaml\n   services:\n     alfresco:\n       image: alfresco/alfresco-content-repository-community:25.1\n       environment:\n         JAVA_OPTS: \u003e-\n           -Dapp.knowledge-discovery.client-id=\u003cyour-client-id\u003e\n           -Dapp.knowledge-discovery.client-secret=\u003cyour-client-secret\u003e\n           -Dapp.knowledge-discovery.oauth-url=https://auth.iam.dev.experience.hyland.com/idp\n           -Dapp.knowledge-discovery.api-url=https://api.ai.dev.experience.hyland.com\n           -Dapp.knowledge-discovery.hx-env-id=\u003cenvironment‑uuid\u003e\n       volumes:\n         - ./extensions/kd-agent-connector-0.8.0.jar:/usr/local/tomcat/webapps/alfresco/WEB-INF/lib/kd-agent-connector-0.8.0.jar\n   ```\n\n4. `docker compose up` – the module is detected at start‑up (`Alfresco modules -\u003e kd-agent-connector`).\n\n### 2. Bare‑metal / classic Tomcat\n\n1. Stop Alfresco.\n2. Create `$ALF_HOME/modules/platform` if it does not exist.\n3. Copy `kd-agent-connector-\u003cversion\u003e.jar` into that directory.\n4. Merge the property block above into `$ALF_HOME/tomcat/shared/classes/alfresco-global.properties`.\n5. Start Alfresco and check `alfresco.log` for\n   `INFO  [org.alfresco.repo.module.ModuleServiceImpl] [main] Installing module 'kd-agent-connector'`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faborroy%2Fkd-agent-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faborroy%2Fkd-agent-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faborroy%2Fkd-agent-connector/lists"}