@aiagenta2z/agtm 1.0.3 → 1.0.5

package/README.md

@@ -1,3 +1,4 @@
+
 ### agtm: Command Line CLI Tool for AI Agent Registry in the Open Source AI Agent Marketplace
 
 [GitHub](https://github.com/aiagenta2z/agtm)|[AI Agent Marketplace CLI Doc](https://www.deepnlp.org/doc/ai_agent_marketplace)|[DeepNLP AI Agent Marketplace](https://www.deepnlp.org/store/ai-agent) | [OneKey Agent Router](https://www.deepnlp.org/agent/onekey-mcp-router) | [Agent MCP OneKey Router Ranking](https://www.deepnlp.org/agent/rankings)
@@ -10,7 +11,6 @@ or a github repo URL in a few seconds.
 To use the command line, you need to first install the package either using python or node environment
 
 
-
 ####  Install and Use `agtm` CLI
 Python
 ``` Python
@@ -44,6 +44,12 @@ Register your AI Agent Marketplace Access Key here (https://deepnlp.org/workspac
 export AI_AGENT_MARKETPLACE_ACCESS_KEY="{your_access_key}"
 ```
 
+You can also use the test key for validation, which is associated with a test-only account on deepnlp.org and aiagenta2z.com. 
+
+```
+export AI_AGENT_MARKETPLACE_ACCESS_KEY="TEST_KEY_AI_AGENT_REGISTRY"
+```
+
 **2. Registry AI Agent from your GitHub**
 
 The default registry provider endpoint includes: [DeepNLP AI Agent Registry Endpoint](https://www.deepnlp.org/api/ai_agent_marketplace/registry) | 
@@ -65,15 +71,9 @@ agtm upload --github https://github.com/AI-Hub-Admin/My-First-AI-Coding-Agent
 ## Register from local config of AI Agent meta
 agtm upload --config ./agent.json
 agtm upload --config ./agent.yaml
-
-
-## Submit to your customized endpoint 
-
-agtm upload --config ./agent.yaml --endpoint https://www.example.com
 ```
 
-
-You can download sample [agent.json](https://github.com/aiagenta2z/agtm/agent.json) or [agent.yaml](https://github.com/aiagenta2z/agtm/agent.yaml) file from github https://github.com/aiagenta2z/agtm
+You can download sample [agent.json](https://github.com/aiagenta2z/agtm/blob/main/agent.json) or [agent.yaml](https://github.com/aiagenta2z/agtm/blob/main/agent.yaml) file from github https://github.com/aiagenta2z/agtm
 See the explanation of the schema, please visit the [documentation](https://www.deepnlp.org/doc/ai_agent_marketplace).
 
 
@@ -116,7 +116,91 @@ price_subscription: "Basic: your basic plan introduction, Advanced: Your Advance
 
 ```
 
-**4. Search AI Agent Marketplace**
+**4. Use your customized endpoint and schema definition**
+
+You have the flexibility to use the AI Agent marketplace/manager cli `agtm` to submit customized ai agent schema to your customized endpoint.
+
+You need to define a customized `schema.json` (https://github.com/aiagenta2z/agtm/blob/main/schema.json) file similar to the default one below and your URL of `endpoint`.
+Then the package will POST the the data schema to your endpoint. 
+
+
+Note: the keys in agent.json and schema.json should match. Package will select keys from the agent.json/agent.yaml files.
+
+
+`schema.json` should have two keys defined the required fields and optional fields you want to submit from the agent.json file. 
+
+Remember to keep the `access_key` in safe place, the post request will post the `access_key` as well as schema to the endpoint. 
+
+## default schema.json definition
+```
+{
+    "required": [
+        "name",
+        "content"
+    ],
+    "optional": [
+        "website", 
+        "field", 
+        "subfield", 
+        "content_tag_list", 
+        "github", 
+        "price_type", 
+        "api", 
+        "thumbnail_picture", 
+        "upload_image_files",
+        "sdk",
+        "package"
+    ]
+}
+```
+
+
+Please visit the command line github package [agtm](https://github.com/aiagenta2z/agtm) and [DOC](https://www.deepnlp.org/doc/ai_agent_marketplace) detailed usage.
+
+
+Use the test account and access 
+
+```
+export AI_AGENT_MARKETPLACE_ACCESS_KEY="TEST_KEY_AI_AGENT_REGISTRY"
+
+agtm upload --config ./agent.json --endpoint https://www.deepnlp.org/api/ai_agent_marketplace/registry --schema ./schema.json
+
+agtm upload --config ./agent.json --endpoint https://www.aiagenta2z.com/api/ai_agent_marketplace/registry --schema ./schema.json
+```
+
+
+```
+Setting Registry Endpoint to URL: https://www.deepnlp.org/api/ai_agent_marketplace/registry
+Customized Schema is enabled : ./schema.json
+Attempting to register agent from config file: ./agent.json
+✅ Loaded custom schema from: ./schema.json
+Using customized schema {"required": ["name", "content"], "optional": ["website", "field", "subfield", "content_tag_list", "github", "price_type", "api", "thumbnail_picture", "upload_image_files", "sdk", "package"]}
+WARN: Calling AddServiceAPI input param optional keys filled fields ['website', 'field', 'subfield', 'content_tag_list', 'github', 'price_type', 'api', 'thumbnail_picture', 'upload_image_files']|missing_fields []
+Submitting agent information to the marketplace...
+
+✅ Registration Successful!
+   URL: https://www.deepnlp.org/store/ai-agent/coding-agent/pub-test-agtm-registry/my-first-ai-coding-agent
+   Message: Content Updated Successfully|Visit URL at https://www.deepnlp.org/store/ai-agent/coding-agent/pub-test-agtm-registry/my-first-ai-coding-agent and Login to View the Pending status webpage...
+   Track its status at: https://www.deepnlp.org/store/ai-agent/coding-agent/pub-test-agtm-registry/my-first-ai-coding-agent
+```
+
+
+Use www.example.com as endpoint example 
+
+
+```
+agtm upload --config ./agent.json --endpoint https://www.example.com --schema ./schema.json
+
+```
+
+It will return an error message showing the endpoint and data, https://www.example.com doesn't have endpoint handling
+
+```
+❌ Registration Failed. Please check your endpoint https://www.example.com  and agent data {'name': 'My First AI Coding Agent', 'content': 'This AI Agent can do complicated programming work for humans', 'website': 'https://www.my_first_agent.com', 'field': 'AI AGENT', 'subfield': 'Coding Agent', 'content_tag_list': 'coding,python', 'github': '', 'thumbnail_picture': 'https://avatars.githubusercontent.com/u/242328252?s=200&v=4', 'upload_image_files': '', 'api': 'https://www.my_first_agent.com/agent', 'price_type': 'FREE', 'price_per_call_credit': 0.0, 'price_fixed_credit': 0.0, 'price_subscription': 'Basic: your basic plan introduction, Advanced: Your Advanced Plan introduction, etc.'}
+```
+
+
+**5. Search AI Agent Marketplace**
 
 ```
 

package/agent.json

@@ -5,12 +5,13 @@
     "field": "AI AGENT",
     "subfield": "Coding Agent",
     "content_tag_list": "coding,python",
-    "github": "",
+    "github": "https://github.com/AI-Hub-Admin/My-First-AI-Coding-Agent",
     "thumbnail_picture": "https://avatars.githubusercontent.com/u/242328252?s=200&v=4",
     "upload_image_files": "",
     "api": "https://www.my_first_agent.com/agent",
     "price_type": "PER_CALL",
     "price_per_call_credit": 0.0,
     "price_fixed_credit" : 0.0,
-    "price_subscription": "Basic: your basic plan introduction, Advanced: Your Advanced Plan introduction, etc."
+    "price_subscription": "Basic: your basic plan introduction, Advanced: Your Advanced Plan introduction, etc.",
+    "new_key_1": "new_value_1"
 }

package/dist/agtm-cli.js

@@ -53,30 +53,72 @@ function loadConfigFile(filePath) {
         process.exit(1);
     }
 }
+/**
+ * Fills a dictionary (JavaScript Object) with values from a source object based on
+ * a list of required and optional keys.
+ */
+function fillItemInfoDict(file_content, required_keys, optional_keys) {
+    const item_info = {};
+    // 1. Process Required Keys
+    if (required_keys && Array.isArray(required_keys)) {
+        for (const key of required_keys) {
+            if (file_content[key] === undefined || file_content[key] === null) {
+                // If a required key is missing or explicitly null/undefined, throw an error.
+                throw new Error(`❌ Error: Required key '${key}' is missing or empty in the file content.`);
+            }
+            // Add the key-value pair to the result dictionary
+            item_info[key] = file_content[key];
+        }
+    }
+    // 2. Process Optional Keys
+    if (optional_keys && Array.isArray(optional_keys)) {
+        for (const key of optional_keys) {
+            // Check if the key exists in the file_content AND hasn't already been added as a required key
+            // (The second part is mostly for efficiency, but also good practice)
+            if (file_content[key] !== undefined && required_keys.indexOf(key) === -1) {
+                // Add the optional key-value pair if it exists
+                item_info[key] = file_content[key];
+            }
+        }
+    }
+    return item_info;
+}
 // --- Command Handlers ---
+const default_required_keys = ["name", "content"];
+const default_optional_keys = [
+    "website", "field", "subfield", "content_tag_list", "github", "price_type",
+    "api", "thumbnail_picture", "upload_image_files", "sdk", "package"
+];
 /**
  * Handles the 'agtm upload' command.
  */
 async function handleUpload(options) {
     const access_key = getAccessKey();
     let item_info = {};
+    // 1.0 set endpoint 
+    const url = options.endpoint || REGISTRY_ENDPOINT;
+    // 2.0 schema
+    var required_keys = [];
+    var optional_keys = [];
+    if (options.schema && options.schema != "") {
+        const schemaConfig = loadConfigFile(options.schema);
+        required_keys = schemaConfig.required;
+        optional_keys = schemaConfig.optional;
+    }
+    else {
+        required_keys = default_required_keys;
+        optional_keys = default_optional_keys;
+    }
     // set default registry endpoint and then change according to github/other configs
-    var internal_endpoint = REGISTRY_ENDPOINT;
     if (options.github) {
         console.log(`\nAttempting to register agent from GitHub: ${options.github}`);
         item_info.github = options.github;
-        internal_endpoint = REGISTRY_ENDPOINT;
     }
     else if (options.config) {
         console.log(`\nAttempting to register agent from config file: ${options.config}`);
         const file_content = loadConfigFile(options.config);
         // Basic validation for config upload
-        if (!file_content.name || !file_content.content) {
-            console.error("❌ Error: Config file must contain 'name' and 'content' fields.");
-            process.exit(1);
-        }
-        item_info = file_content;
-        internal_endpoint = REGISTRY_ENDPOINT_v1;
+        item_info = fillItemInfoDict(file_content, required_keys, optional_keys);
     }
     else {
         // Should be handled by commander's required option check, but kept as safeguard.
@@ -86,13 +128,13 @@ async function handleUpload(options) {
     // decide endpoint
     // if github mode, set to REGISTRY_ENDPOINT, otherwise if config mode set to REGISTRY_ENDPOINT_v1
     // if endpoint set externally, has higher priority.
-    const url = options.endpoint || internal_endpoint;
     // console.log(`DEBUG: options.endpoint ${options.endpoint}`);
     // console.log(`DEBUG: internal_endpoint ${internal_endpoint}`);
     // console.log(`DEBUG: final url ${url}`);
     // Prepare payload (combining item info and access key)
     const payload = { ...item_info, access_key };
     console.log(`Submitting agent information to endpoint: ${url}`);
+    console.log(`Submitting agent information to payload: ${JSON.stringify(item_info)}`);
     try {
         const response = await axios.post(url, payload, {
             headers: { 'Content-Type': 'application/json' },
@@ -163,16 +205,16 @@ const program = new Command();
 program
     .name('agtm')
     .description('An Open Source Command-line Tool for AI Agents meta registry, AI Agents Marketplace Management, AI Agents Search and AI Agents Index Services. Help users to explore interesting AI Agents. Documentation: https://www.deepnlp.org/doc/ai_agent_marketplace, Marketplace: https://www.deepnlp.org/store/ai-agent')
-    .version('1.0.0');
+    .version('1.0.4');
 // 1. UPLOAD Command
 const uploadCommand = program.command('upload')
     .description('Register or update AI Agent meta information in the marketplace.')
     .action(handleUpload);
 // Mutually Exclusive Group (managed with custom logic and checks)
 uploadCommand.option('--github <url>', 'The GitHub repository URL for the open-sourced agent.');
-uploadCommand.option('--config <path>', 'Path to a .json or .yaml file containing the agent\'s meta information.');
-// Custom check for the required mutual exclusion
+uploadCommand.option('--config <path>', 'Path to a .json or .yaml, agent.json file containing the agent\'s meta information.');
 uploadCommand.option('--endpoint <url>', 'The endpoint URL to post data to (overrides default).', "");
+uploadCommand.option('--schema <path>', 'Path to a .json or .yaml, schema.json file containing the agent\'s meta information.', "");
 uploadCommand.hook('preAction', (thisCommand) => {
     const options = thisCommand.opts();
     if (!options.github && !options.config) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiagenta2z/agtm",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "agtm: Open Source CLI for AI Agent Marketplace Registration, AI Agents Management, AI Agents Index and Search",
   "main": "dist/agtm-cli.js",
   "type": "module",
@@ -14,7 +14,8 @@
     "dist",
     "README.md",
     "agent.json",
-    "agent.yaml"
+    "agent.yaml",
+    "schema.json"
   ],
   "author": "deepnlp",
   "license": "ISC",
@@ -31,6 +32,7 @@
   },
   "repository": {
     "type": "git",
-    "url": ""
-  }
+    "url": "https://github.com/aiagenta2z/agtm"
+  },
+  "homepage": "https://www.deepnlp.org/store/ai-agent"
 }

package/schema.json

@@ -0,0 +1,19 @@
+{
+    "required": [
+        "name",
+        "content"
+    ],
+    "optional": [
+        "website", 
+        "field", 
+        "subfield", 
+        "content_tag_list", 
+        "github", 
+        "price_type", 
+        "api", 
+        "thumbnail_picture", 
+        "upload_image_files",
+        "sdk",
+        "package"
+    ]
+}