Skip to content

README Updates #3

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

Merged
sam-namecom merged 2 commits into from
Jun 3, 2025
Merged

README Updates #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01b2fb7
README updates
sam-namecom Jun 3, 2025
1eeb4f1
Merge branch 'main' of https://github.com/namedotcom/namecom-mcp into…
sam-namecom Jun 3, 2025
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
56 changes: 0 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ A Model Context Protocol (MCP) server that provides access to the Name.com API f

## Installation

### Quick Start (Recommended)

The easiest way to get started - no building required!

```bash
Expand All @@ -37,17 +35,6 @@ npm install -g namecom-mcp

That's it! The package comes pre-compiled and ready to use.

### From Source (For Development)

Only needed if you want to modify the code:

```bash
git clone https://github.com/namedotcom/namecom-mcp.git
cd namecom-mcp
npm install
npm run build
```

## Configuration

### Prerequisites
Expand Down Expand Up @@ -267,41 +254,6 @@ The server dynamically generates tools based on the Name.com OpenAPI specificati
- **Input Validation**: All inputs are validated using Zod schemas
- **Error Handling**: Errors are handled gracefully without exposing sensitive information

## Development

### For Contributors and Developers

Building from source is only needed if you want to modify the code or contribute to the project.

```bash
git clone https://github.com/namedotcom/namecom-mcp.git
cd namecom-mcp
npm install
npm run build
```

### Running in Development Mode

```bash
npm run dev
```

### Project Structure

```
src/
├── index.ts # Main entry point
├── config.ts # Configuration and environment variables
├── api-client.ts # Name.com API client
├── tool-generator.ts # Dynamic tool generation from OpenAPI spec
├── openapi-utils.ts # OpenAPI specification utilities
└── types.ts # TypeScript type definitions
```

### Publishing

The package is automatically built before publishing thanks to the `prepublishOnly` script. The published package includes the compiled `dist` directory, so users don't need to build anything.

## Troubleshooting

### Common Issues
Expand Down Expand Up @@ -336,14 +288,6 @@ If you run into issues:
3. Verify your credentials work with Name.com's API directly
4. Open an issue on GitHub with detailed error messages

## Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

## License

MIT License - see [LICENSE](LICENSE) file for details.
Expand Down