AI-Engineer-Foundation / agent-protocol

Common interface for interacting with AI agents. The protocol is tech stack agnostic - you can use it with any framework for building agents.
https://agentprotocol.ai
MIT License
851 stars 102 forks source link

JS Client - OpenAPI Generator generates wrong version format and incomplete details #115

Open jzanecook opened 2 months ago

jzanecook commented 2 months ago

Is your feature request related to a problem? Please describe. The JS Client will override the package.json and README with details that are incorrect. The expected changes are as follows:

Steps to reproduce

Here is the current output of the package.json file.

{
  "name": "agent-protocol-client",
  "version": "v1",
  "description": "OpenAPI client for agent-protocol-client",
  "author": "OpenAPI-Generator",
  "repository": {
    "type": "git",
    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
  },
  "main": "./dist/index.js",
  "typings": "./dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "prepare": "npm run build"
  },
  "devDependencies": {
    "typescript": "^4.0"
  }
}

Here is the expected output of the package.json

{
  "name": "agent-protocol-client",
  "version": "v1.0.0",     <----- Version should use semantic
  "description": "Typescript Client for the Agent Protocol", <----- Description should be more specific about the agent protocol client for the npm package.
  "author": "AI Engineer Foundation",   <----- Author should be AI Engineer Foundation
  "repository": {
    "type": "git",
    "url": "https://github.com/AI-Engineer-Foundation/agent-protocol.git" <----- Repository should be the correct one
  },
  "main": "./dist/index.js",
  "typings": "./dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "prepare": "npm run build"
  },
  "devDependencies": {
    "typescript": "^4.0"
  }
}

About the README

The README should ideally include the instructions on setting up the minimal example and using the client to a base level. Reference the current (modified) README file for the added section on setting up the example.

jzanecook commented 2 months ago

@wilsonianb @hackgoofer Please take a look when you get a chance :+1: