Content
# Twproject MCP Server Prototype
Prototype MCP server for automating routine operations on a regular licensed, trial, or free Twproject installation, including Twproject Cloud and self-hosted/on-premise instances.
This project is intended to reduce manual work for users who already have lawful access to a Twproject instance. It is not a replacement for Twproject, does not include Twproject software, and does not grant any Twproject license, subscription, API entitlement, trademark right, support right, or other permission.
## Status
This repository is a prototype.
- APIs and tool schemas may change.
- Twproject API behavior must be validated against the target instance before production use.
- Delete/destructive operations are intentionally not implemented in v1.
- Use dry-run mode first when testing new commands or payloads.
## Legal And Trademark Notice
This project is independent and is not affiliated with, endorsed by, sponsored by, or approved by Twproject or its owners.
Twproject, the Twproject name, logo, product, cloud service, documentation, APIs, and related marks or materials belong to their respective owner(s). All rights in Twproject and Twproject-related intellectual property are reserved by those owner(s).
This repository only contains integration code written for this MCP server. It does not copy, redistribute, sublicense, reverse engineer, or modify Twproject itself.
You are responsible for ensuring that your use of this project complies with:
- your Twproject license, subscription, trial, or free-version terms;
- Twproject Cloud or self-hosted/on-premise terms of service;
- API usage rules and rate limits;
- your organization's security and data-protection policies;
- applicable privacy, employment, export-control, and computer-access laws.
Do not use this project to bypass Twproject authentication, authorization, license limits, technical restrictions, user permissions, audit controls, or commercial terms.
Nothing in this repository is legal advice. Review the applicable Twproject agreements and consult qualified counsel if you need legal certainty.
## License Choice
Recommended license for this public GitHub prototype: **Apache License 2.0**.
Why Apache-2.0:
- permissive for personal, internal, and commercial use;
- allows forks and contributions without forcing downstream projects to become open source;
- includes an explicit patent license from contributors;
- includes clear warranty and liability disclaimers;
- is widely understood by companies and open-source contributors.
The license applies only to this repository's own code and documentation. It does not apply to Twproject or any Twproject-owned software, service, documentation, trademark, logo, API, or other asset.
See [LICENSE](./LICENSE).
## Configuration
Set these environment variables before running against Twproject:
```text
TWPROJECT_BASE_URL=https://nexusesoci.twproject.cloud/
TWPROJECT_API_KEY=your-api-key
TWPROJECT_TIMEOUT_MS=30000
TWPROJECT_DRY_RUN=false
```
For local development without credentials, set `TWPROJECT_DRY_RUN=true`. Dry-run mode returns the Twproject request shape without sending network traffic and never includes the API key.
Never commit `.env` files, API keys, session cookies, exported Twproject data, customer data, or production payload samples containing confidential information.
## Security Defaults
- API keys are read only from environment variables.
- API keys are never accepted from MCP tool arguments.
- API keys are redacted from startup errors and client errors.
- The Twproject base URL must use HTTPS.
- The server accepts no user-controlled outbound URL or custom headers.
- Generic API calls block delete-like commands.
- MCP stdio protocol output is kept separate from diagnostics.
## Tools
The server exposes:
- `twproject_api_call` for safe, non-destructive Twproject API calls.
- `twproject_task_get`, `twproject_task_search`, `twproject_task_create`, `twproject_task_update`.
- Equivalent `get`, `search`, `create`, and `update` tools for `assignment`, `issue`, `person`, `company`, `worklog`, and `cost`.
No delete tools are exposed in v1.
## Commands
```bash
npm install
npm run build
npm test
npm run lint
```
Run the server:
```bash
node dist/index.js
```
