mcp-text-improver 1.0.0

package/README.md

@@ -0,0 +1,144 @@
+# MCP Text Improver
+
+A **proof of concept** [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that improves informal text with proper grammar, capitalization, and punctuation. Built with AI assistance to demonstrate how easy it is to create, deploy, and share your own MCP servers.
+
+> **Educational Template**: This project shows the complete MCP development lifecycle - from setup to deployment. Use it as a foundation to build your own tools!
+
+## Index
+
+- [What is it?](#what-is-it)
+- [Examples](#examples)
+- [Quick Start](#quick-start)
+  - [Install](#1-install)
+  - [Configure Your MCP Client](#2-configure-your-mcp-client)
+  - [Use It](#3-use-it)
+- [Alternative Installation Methods](#alternative-installation-methods)
+- [Glossary](#glossary)
+- [FAQ](#faq)
+- [Learn More](#learn-more)
+
+## What is it?
+
+An MCP server that transforms informal text into properly formatted output:
+- Converts slang to formal language (`gonna` → `going to`)
+- Fixes grammar and capitalization (`i dont` → `I don't`)
+- Adds proper punctuation
+- Replaces intensifiers (`very good` → `excellent`)
+
+**Perfect for learning** how to build MCP servers with AI assistance.
+
+## Examples
+
+```
+Input:  "i am gonna go out cause its very bad weather"
+Output: "I'm going to go out because its terrible weather."
+
+Input:  "i dont like this"
+Output: "I don't like this."
+```
+
+## Quick Start
+
+### 1. Install
+
+```bash
+git clone https://bitbucket.es.ad.adp.com/scm/mcpdev/mcp-text-improver.git
+cd mcp-text-improver
+npm install
+npm run build
+```
+
+### 2. Configure Your MCP Client
+
+**Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+```json
+{
+  "mcpServers": {
+    "text-improver": {
+      "command": "node",
+      "args": ["/absolute/path/to/mcp-text-improver/dist/server.js"]
+    }
+  }
+}
+```
+
+**Other MCP Clients**: See [Setup Guide](docs/01.setup.md) for more options.
+
+### 3. Use It
+
+Restart your MCP client and ask:
+```
+"Can you improve this text: i am gonna go out"
+```
+
+## Alternative Installation Methods
+
+If you don't have git access or prefer file-based sharing, use these options:
+
+### Option 1: ZIP File (No permissions needed)
+
+1. Download or receive the `mcp-text-improver-poc.zip` file
+2. Unzip it: `unzip mcp-text-improver-poc.zip`
+3. Install dependencies: `cd mcp-text-improver && npm install`
+4. Configure MCP client with absolute path to `dist/server.js`
+
+### Option 2: NPM Package Tarball (No permissions needed)
+
+1. Download or receive the `mcp-text-improver-1.0.0.tgz` file
+2. Install from file: `npm install /path/to/mcp-text-improver-1.0.0.tgz`
+3. Configure MCP client with the installed location
+
+**See [Internal POC (No Registry)](docs/03.create-your-own.md#internal-poc-no-registry) for detailed setup for each option.**
+
+## Glossary
+
+**MCP Server**: A program that provides tools/functions to AI assistants via the Model Context Protocol.
+
+**MCP Client**: An application (Claude Desktop, GitHub Copilot) that connects to and uses MCP servers.
+
+**Tool**: A specific function your MCP server exposes (e.g., `improve_text`).
+
+**Schema**: A definition of what inputs a tool accepts (parameter types, descriptions).
+
+**stdio (standard input/output)**: Communication method used by MCP — servers read requests from stdin and write responses to stdout.
+
+**Handler**: The code that executes when a tool is called.
+
+**Distribution**: How you share your MCP tool with others (ZIP, tarball, npm, Git repo).
+
+## FAQ
+
+**Q: Can I use this tool with [other MCP client]?**  
+A: Yes! Any MCP-compatible client works. See [Setup Guide](docs/01.setup.md#configuration) for client-specific config instructions.
+
+**Q: What if my server crashes or isn't loading?**  
+A: Check [Common Issues](docs/01.setup.md#common-issues) in the Setup Guide. Most issues are path or Node.js version related.
+
+**Q: Can I run multiple MCP servers at once?**  
+A: Yes. Configure multiple entries in your client's config file (one per tool).
+
+**Q: How do I debug my MCP server?**  
+A: Use `console.error()` in your code; check your MCP client's logs. See [Development Workflow](docs/01.setup.md#development-workflow) for the build → test cycle.
+
+**Q: Do I need npm publish rights to share my tool?**  
+A: No! Use ZIP or tarball distribution (no permissions needed). See [Internal POC](docs/03.create-your-own.md#internal-poc-no-registry) options.
+
+**Q: What Node.js version do I need?**  
+A: v18 or higher. Check your version: `node --version`
+
+## Learn More
+
+### Documentation
+- 📦 **[Setup Guide](docs/01.setup.md)** - Development setup, building, and testing
+- 🔧 **[How It Works](docs/02.how-it-works.md)** - API reference and transformation rules
+- 🚀 **[Create Your Own](docs/03.create-your-own.md)** - Build your own MCP server from scratch
+- ✅ **[Complete Workflow + Permissions](docs/03.create-your-own.md#complete-workflow-develop--build--publish)** - End-to-end process another developer can follow
+- 🧩 **[Internal POC (No Registry)](docs/03.create-your-own.md#internal-poc-no-registry)** - Share internally without Artifactory/npm permissions
+
+### Resources
+- [Model Context Protocol](https://modelcontextprotocol.io) - Official MCP documentation
+- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk) - SDK reference
+
+---
+
+**Built as an educational template for the community** 🚀

package/package.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json.schemastore.org/package",
+  "name": "mcp-text-improver",
+  "version": "1.0.0",
+  "description": "An MCP server that improves informal text with proper grammar, capitalization, and punctuation.",
+  "main": "build/server.js",
+  "scripts": {
+    "dev": "node --loader ts-node/esm src/server.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "text-improvement",
+    "grammar",
+    "ai-tools"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.es.ad.adp.com/scm/mcpdev/mcp-text-improver.git"
+  },
+  "type": "module",
+  "files": [
+    "build",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.27.1",
+    "zod": "^4.3.6",
+    "zod-to-json-schema": "^3.25.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}