Skip to content

setup npm distribution#19

Merged
Andrew-Paystack merged 5 commits into
mainfrom
feat/npm-publish
Mar 12, 2026
Merged

setup npm distribution#19
Andrew-Paystack merged 5 commits into
mainfrom
feat/npm-publish

Conversation

@Andrew-Paystack
Copy link
Copy Markdown
Member

This p/r structures the MCP to be distributed via NPM

Comment thread README.md Outdated
The Paystack MCP Server works with any MCP-compatible client. Below is the standard configuration schema used by most clients (Claude Desktop, ChatGPT Desktop, Cursor, Windsurf, etc.).

### Using a local build
### Using npm (recommended)\n\nFor npm-installed server:\n\n```json\n{\n \"mcpServers\": {\n \"paystack\": {\n \"command\": \"npx\",\n \"args\": [\"@paystack/mcp-server\", \"--api-key\", \"sk_test_...\"]\n }\n }\n}\n```\n\n### Using a local build
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you've got some formatting issues here @Andrew-Paystack, I think you need to remove the newline characters

Comment thread package.json
"@modelcontextprotocol/inspector": "^0.18.0",
"@modelcontextprotocol/sdk": "^1.26.0",
"dotenv": "^17.2.3",
"zod": "^4.3.6"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see zod is still being imported at the beginning of make-paystack-request.ts, won't the build fail if you've removed it as a dependency?

Comment thread SETUP.md Outdated
@@ -0,0 +1,174 @@
# Editor Setup
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have README.md, why the additional file? Seems like this should all just go in the existing file instead

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tolu-paystack I figured that as tools keep increasing, people would like to add how to setup theirs. I wanted to keep Setup separate from the ReadMe so that the read-me is clear.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think let's wait till we get to that point to create a separate file. The readme isn't too long as-is. Plus you can just add a table of contents to the top of the file to make for easier navigation

Comment thread src/index.ts Outdated
@@ -1,7 +1,64 @@
#!/usr/bin/env node
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's clean this up

Comment thread src/index.ts
}

// Check if we have an API key from CLI or environment
if (!cliApiKey && !process.env.PAYSTACK_TEST_SECRET_KEY) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is similar to what is being done in the config file. Can we consolidate?

Comment thread package.json Outdated
},
"bin": {
"paystack": "./build/index.js"
"paystack-mcp": "./build/index.js"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use paystack-mcp-server

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants