This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-mcp-server.git
The following commit(s) were added to refs/heads/master by this push:
new 4a63fd6 chore: readme updates (#16)
4a63fd6 is described below
commit 4a63fd60e1ee9511b87f4a8643af4140c2958ba5
Author: Robert Munteanu <[email protected]>
AuthorDate: Thu Mar 26 09:54:05 2026 +0100
chore: readme updates (#16)
---------
Co-authored-by: Konrad Windszus <[email protected]>
---
README.md | 23 ++++++++++++++++++++---
1 file changed, 20 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index ed82a21..a0a2dee 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
Experimental MCP Server implementation for Apache Sling.
-## Usage
+## Development
Build the project with Maven and start up the MCP server, based on the Apache
Sling Starter:
@@ -23,7 +23,7 @@ the configuration can look as follows
```json
"aem-cs-sdk": {
"type": "streamable-http",
- "url": "http://localhost:4502/bin/mcp";,
+ "url": "http://localhost:8080/bin/mcp";,
"headers": {
"Authorization": "Basic YWRtaW46YWRtaW4="
}
@@ -32,6 +32,23 @@ the configuration can look as follows
Please refer to the documentation of your coding assistant tool for details on
how to add a remote MCP server and specify authentication headers.
+## Deployment
+
+The [src/main/features/main.json](src/main/features/main.json) files contains
bundles and configurations that are required for deploying
+on top of the version of the Sling Starter defined in [pom.xml](pom.xml).
+
+This file is intended mostly for local development but can also be used as a
blueprint for including the bundle
+in Sling Starter based deployments.
+
+To obtain a ready to use target file:
+
+- build the project with `mvn package`
+- copy the file `target/slingfeature-tmp/main.json` to your own project
+- adjust the metadata from the feature file as needed ( id, title, etc )
+
## Legacy artifact
-For applications still using the older slf4j 1.x and javax.servlet APIs a
classifier with the 'legacy' classifier is built.
+For applications still using the older slf4j 1.x and javax.servlet APIs a
bundle with the 'legacy' classifier is built.
+
+This bundle is not included in the feature model used for local development
and integration tests and needs to be deployed
+manually in the applications that consume it.
