Let a compatible AI client search and inspect FormKiQ documents through Model Context Protocol. The open-source FormKiQ MCP server connects to an existing FormKiQ deployment and exposes supported API operations as tools.
Read-only access is the default. Write operations and permanent purge require separate opt-in settings, and FormKiQ still enforces the downstream identity's permissions.
Inspect the source and setup guideFrom client request to authorized document operation
- 1 · Client
Select a supported tool
The AI client discovers the enabled document tools and their input schemas. The server also exposes the bundled JWT OpenAPI specification as an MCP resource.
- 2 · MCP server
Validate and forward
The server validates arguments and forwards the permitted operation to the configured FormKiQ JWT endpoint. API groups, module availability, and access settings determine the exposed tools.
- 3 · FormKiQ
Apply API permissions
FormKiQ evaluates the request using the configured JWT identity. The server returns a bounded result to the client, which handles the conversation and any model processing.
Illustrative read-only request · fictional identifiers
Inspect a known document
A permitted client can call the get_document tool with a document ID and site:
{"documentId":"sample-agreement-123","siteId":"procurement"}The call requests the document record. Access depends on the JWT and site permissions; knowing an ID does not grant access. Use the separate supported content or download operations when the task needs file content.
For discovery, use list_formkiq_operations and describe_operation to inspect the enabled interface. Tool coverage and FormKiQ API versions are versioned separately; pin a server release and validate it against your deployment.
Choose a transport and identity model
| Area | Current implementation | Deployment decision |
|---|---|---|
| Local client | Stdio lets the client launch the server as a local process. | Supply configuration and a scoped JWT through the client environment. |
| HTTP service | Streamable HTTP supports a separately running server. Hosted access uses configured caller authentication and policies. | Configure TLS, caller tokens, permitted sites and operations, and downstream identities using the repository's hosting instructions. |
| FormKiQ authentication | Bearer JWT through the CloudFormation HttpApiUrl output. | Supply a current token and plan token replacement. IAM signing and API-key authentication are not implemented by this MCP server. |
| Changes to records | Writes are disabled by default; purge has an additional setting. | Enable only the operations required for the task, with appropriate permissions and review. |
Prepare a first connection
- Use a deployed FormKiQ API and a dedicated, minimally privileged JWT identity.
- Follow the release-pinned client setup in the repository; keep credentials out of source control.
- Inspect enabled tools and confirm any required commercial modules are installed and licensed.
- Test an allowed read, a denied read, an incorrect site, and an expired token.
- Review what content the MCP client sends to its model provider and retains in logs or history.
The MCP server is open-source integration software; the connected FormKiQ edition and selected modules retain their own licensing and operating requirements. The repository documents supported clients, configuration, and current limitations.
Use MCP for document operations
MCP connects an agent to supported FormKiQ API tools. For questions across an indexed collection, evaluate KnowledgeBase; for extracting information from an incoming file, evaluate AI Processing and Analysis.
Current installation and client examples · Plan an agent-assisted workflow · Explore APIs and deployment evidence
Review your agent's document access
Bring the client, target task, and identity model. We can review the FormKiQ API and module scope alongside your deployment requirements.
Book a technical review