Skip to content

Point scaffolds and README install at the published npm package #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
haasonsaas wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Point scaffolds and README install at the published npm package #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@

Turn an OpenAPI 3.x spec into an MCP server. Each operation becomes an MCP tool; tool calls are validated, proxied to the upstream REST API, and the response is validated against the spec's response schemas.

> **Package name: `@evalops/mcp-openapi`.** The unscoped `mcp-openapi` package on the npm registry is an unrelated third-party project. Install this project from GitHub (`npm install github:evalops/mcp-openapi`) or from npm under the scoped name once a tagged release has been published.
> **Package name: `@evalops/mcp-openapi`.** The unscoped `mcp-openapi` package on the npm registry is an unrelated third-party project.

```bash
npm install @evalops/mcp-openapi # from npm
npm install github:evalops/mcp-openapi # from source
```

## Quickstart

Expand Down
4 changes: 2 additions & 2 deletions src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ async function scaffoldProject(targetDir: string): Promise<void> {
},
dependencies: {
// The npm package named "mcp-openapi" is an unrelated third-party project; this package is @evalops/mcp-openapi.
"@evalops/mcp-openapi": "github:evalops/mcp-openapi"
"@evalops/mcp-openapi": "^0.5.0"
},
devDependencies: {
"@types/node": "^22.13.4",
Expand Down Expand Up @@ -931,7 +931,7 @@ async function generateProjectFromSpec(targetDir: string, specPath: string, oper
build: "tsc -p tsconfig.json",
start: "node dist/server.js"
},
dependencies: { "@evalops/mcp-openapi": "github:evalops/mcp-openapi" },
dependencies: { "@evalops/mcp-openapi": "^0.5.0" },
devDependencies: { typescript: "^5.7.3", tsx: "^4.20.3", "@types/node": "^22.13.4" }
},
null,
Expand Down
2 changes: 1 addition & 1 deletion test/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ test("scaffolds depend on the GitHub source, not the unrelated npm package", asy
const packageJson = JSON.parse(await readFile(resolve(outDir, "package.json"), "utf8")) as {
dependencies: Record<string, string>;
};
assert.equal(packageJson.dependencies["@evalops/mcp-openapi"], "github:evalops/mcp-openapi");
assert.equal(packageJson.dependencies["@evalops/mcp-openapi"], "^0.5.0");
});
Loading