{"id":44008990,"url":"https://github.com/1shooperman/articles","last_synced_at":"2026-02-07T14:09:48.125Z","repository":{"id":328009473,"uuid":"1113921584","full_name":"1shooperman/articles","owner":"1shooperman","description":"Basis for a local mcp server to give me a cursor command to generate a blog article for my sites.","archived":false,"fork":false,"pushed_at":"2026-02-03T01:33:30.000Z","size":396,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-03T08:42:55.338Z","etag":null,"topics":["tools"],"latest_commit_sha":null,"homepage":"https://brandonshoop.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1shooperman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-10T16:43:23.000Z","updated_at":"2026-02-03T01:33:33.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/1shooperman/articles","commit_stats":null,"previous_names":["1shooperman/articles"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/1shooperman/articles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1shooperman%2Farticles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1shooperman%2Farticles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1shooperman%2Farticles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1shooperman%2Farticles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1shooperman","download_url":"https://codeload.github.com/1shooperman/articles/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1shooperman%2Farticles/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29196750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T12:38:28.597Z","status":"ssl_error","status_checked_at":"2026-02-07T12:38:23.888Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["tools"],"created_at":"2026-02-07T14:09:46.262Z","updated_at":"2026-02-07T14:09:48.117Z","avatar_url":"https://github.com/1shooperman.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Articles\n\nA command-line tool for creating structured markdown articles from templates. This repository manages a corpus of articles with support for blog posts and project documentation.\n\n## Features\n\n- **Template-based article creation** - Create articles from predefined templates (blog or project)\n- **Interactive prompts** - Guided workflow for filling in article metadata\n- **Default values** - Templates can include default values that are automatically used\n- **YAML frontmatter** - Articles include structured metadata in YAML format\n- **Automatic date generation** - Dates are automatically generated if not provided\n- **Filename collision detection** - Automatically handles filename conflicts\n\n## Installation\n\n1. Clone this repository\n2. Install dependencies:\n\n```bash\nnpm install\n```\n\n## Usage\n\n### Interactive Mode\n\nRun the script without arguments for an interactive experience:\n\n```bash\nnpm run create\n```\n\nOr directly:\n\n```bash\ntsx create-article.ts\n```\n\nThe script will:\n1. Prompt you to select a template type (blog or project)\n2. Ask for a filename\n3. Guide you through required fields\n4. Prompt for optional fields\n5. Create the article in the `articles/` directory\n\n### Command Line Arguments\n\nYou can also provide arguments to skip some prompts:\n\n```bash\n# Specify template type\nnpm run create -- --type blog\nnpm run create -- --type project\n\n# Specify template type and filename\nnpm run create -- --type blog --name my-article\nnpm run create -- -T project -N my-project\n```\n\n**Arguments:**\n- `--type` or `-T`: Template type (`blog` or `project`)\n- `--name` or `-N`: Filename (without `.md` extension)\n\n## Template Types\n\n### Blog Template\n\nThe blog template includes:\n- **Required fields:**\n  - `title`: Blog post title\n  - `date`: Publication date (auto-generated if not provided)\n  - `excerpt`: Brief summary\n  - `author`: Author name (defaults to \"Brandon Shoop\")\n\n- **Optional fields:**\n  - `dateModified`: Last modified date\n\n### Project Template\n\nThe project template includes:\n- **Required fields:**\n  - `title`: Project title\n  - `date`: Publication date\n  - `description`: Brief project description\n\n- **Optional fields:**\n  - `features`: Array of feature descriptions\n  - `technologies`: Array of technologies used\n  - `links`: Array of links (e.g., App Store, GitHub) with text and URL\n  - `applicationCategory`: Type of application\n  - `operatingSystem`: Target operating system(s)\n\n## Default Values\n\nTemplates can include default values in their frontmatter. When you press Enter without providing a value:\n\n- **Required fields:** The default value will be used automatically\n- **Optional fields:** The default value will be used if available, otherwise the field is skipped\n\nDefault values are displayed in prompts like: `title (required) [default: Your Default Title]:`\n\n## MCP Server\n\nAn MCP (Model Context Protocol) server exposes the same article-creation flow to AI agents over stdio or Streamable HTTP.\n\n### Build and run\n\n**From a clone (build first):**\n\nFrom the repo root:\n\n```bash\n# Build root + mcp-server\nnpm run build:mcp\n\n# Run over stdio (for Cursor / Claude Desktop)\nnode mcp-server/dist/stdio.js\n\n# Run over Streamable HTTP (port 3000 by default)\nARTICLES_MCP_PORT=3000 node mcp-server/dist/sse.js\n```\n\n**From a release (no build):**\n\n1. Download a release zip from the [Releases](https://github.com/bshoop/articles/releases) page (e.g. `articles-v1.0.0.zip`).\n2. Extract the zip and `cd` into the extracted folder.\n3. Install dependencies (the zip includes built `dist/` but not `node_modules`):\n\n   ```bash\n   npm ci\n   cd mcp-server \u0026\u0026 npm ci \u0026\u0026 cd ..\n   ```\n\n4. Run the MCP server:\n\n   ```bash\n   node mcp-server/dist/stdio.js\n   ```\n\n   Or for Streamable HTTP: `ARTICLES_MCP_PORT=3000 node mcp-server/dist/sse.js`\n\nIn Cursor, use the **absolute path** to the extracted folder, e.g. `.../articles-v1.0.0/mcp-server/dist/stdio.js`.\n\n### Cursor configuration\n\nAdd the server in Cursor (e.g. **Settings \u003e MCP**) with **stdio**:\n\n- **Command:** `node`\n- **Args:** `[\"/absolute/path/to/articles/mcp-server/dist/stdio.js\"]`\n\nRun from the articles repo root so templates and `articles/` resolve correctly. To use a different repo root, set `ARTICLES_REPO_ROOT` in the server’s `env` to the absolute path of the articles repo.\n\n### Copy to another project\n\nTo copy each created article into another project (e.g. your blog repo), set **ARTICLES_COPY_TO** in the MCP server’s `env` to the target directory (absolute path recommended). The created file is written into the articles repo’s `articles/` dir and then copied to that path.\n\nSee [mcp-server/README.md](mcp-server/README.md) for details.\n\n## Project Structure\n\n```\narticles/\n├── articles/          # Generated articles are stored here\n├── BLOG.md           # Blog post template\n├── PROJECT.md        # Project documentation template\n├── create-article.ts # Main script\n├── mcp-server/       # MCP server (stdio + Streamable HTTP)\n└── package.json      # Dependencies and scripts\n```\n\n## Template Format\n\nTemplates use markdown with YAML frontmatter. The frontmatter includes:\n\n- Section headers: `# [TYPE] Required fields:` and `# [TYPE] Optional fields:`\n- Field definitions with example values\n- Default values that can be used automatically\n\nExample template structure:\n\n```yaml\n---\n# [BLOG] Required fields:\ntitle: \"Your Blog Post Title\"\ndate: \u003cDATE\u003e\nexcerpt: \"A brief summary\"\nauthor: \u003cAUTHOR\u003e\n\n# [BLOG] Optional fields:\n# dateModified: \"2025-01-02\"\n---\n```\n\n## Output\n\nArticles are saved in the `articles/` directory with:\n- Filename based on your input (sanitized for filesystem compatibility)\n- YAML frontmatter with all provided metadata\n- Template body content\n- Automatic date generation in `YYYY-MM-DD` format\n\nIf a file with the same name already exists, a timestamp suffix is added to prevent overwriting.\n\n## Author\n\nBrandon Shoop\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1shooperman%2Farticles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1shooperman%2Farticles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1shooperman%2Farticles/lists"}